public interface ProcessManagementAPI extends ProcessManagementAPI
ProcessManagementAPI
extends ProcessManagementAPI
and adds capabilities on Parameter
s, activity
replay, connector implementation hot-replace.Modifier and Type | Method and Description |
---|---|
List<ConnectorInstance> |
getConnectorInstancesOfActivity(long activityInstanceId,
int startIndex,
int maxResults,
ConnectorInstanceCriterion sortingCriterion)
Retrieve the list of connector instances on an activity instance
|
List<ConnectorInstance> |
getConnectorInstancesOfProcess(long processInstanceId,
int startIndex,
int maxResults,
ConnectorInstanceCriterion sortingCriterion)
Retrieve the list of connector instances on a process instance
|
int |
getNumberOfParameterInstances(long processDefinitionId)
Gets how many parameters the process definition contains.
|
long |
getNumberOfProcessSupervisorsForGroup(long processDefinitionId)
Get the number of processes supervisors mapped to a specific group.
|
long |
getNumberOfProcessSupervisorsForMembership(long processDefinitionId)
Get the number of processes supervisors mapped to a specific membership.
|
long |
getNumberOfProcessSupervisorsForRole(long processDefinitionId)
Get the number of processes supervisors mapped to a specific role.
|
long |
getNumberOfProcessSupervisorsForUser(long processDefinitionId)
Get the number of processes supervisors mapped to a specific user.
|
ParameterInstance |
getParameterInstance(long processDefinitionId,
String parameterName)
Get a parameter instance by process definition UUID
|
List<ParameterInstance> |
getParameterInstances(long processDefinitionId,
int startIndex,
int maxResults,
ParameterCriterion sort)
Returns the parameters of a process definition or an empty map if the process does not contain any parameter.
|
void |
importParameters(long processDefinitionId,
byte[] parameters)
Imports the parameters of the process definition.
|
void |
replayActivity(long activityInstanceId)
Replay a task that was in failed state.
|
void |
replayActivity(long activityInstanceId,
Map<Long,ConnectorStateReset> connectorsToReset)
Set state of activity to its previous state and then execute.
|
void |
setConnectorImplementation(long processDefinitionId,
String connectorName,
String connectorVersion,
byte[] connectorImplementationArchive)
Updates the implementation version of the connector of the process definition.
|
void |
setConnectorInstanceState(long connectorInstanceId,
ConnectorStateReset state)
Allows to reset the state of an instance of connector
|
void |
setConnectorInstanceState(Map<Long,ConnectorStateReset> connectorsToReset)
Allows to reset connector instance states for a Collection of connector instances at once.
|
void |
updateParameterInstanceValue(long processDefinitionId,
String parameterName,
String parameterValue)
Update an existing parameter of a process definition.
|
addCategoriesToProcess, addGroupToActor, addGroupToActor, addProcessDefinitionsToCategory, addProcessDefinitionToCategory, addRoleAndGroupToActor, addRoleAndGroupToActor, addRoleToActor, addRoleToActor, addUserToActor, addUserToActor, createCategory, createProcessSupervisorForGroup, createProcessSupervisorForMembership, createProcessSupervisorForRole, createProcessSupervisorForUser, deleteCategory, deleteProcess, deleteProcessDefinition, deleteProcessDefinitions, deleteProcesses, deleteSupervisor, deleteSupervisor, deploy, deploy, deployAndEnableProcess, deployAndEnableProcess, disableAndDelete, disableAndDeleteProcessDefinition, disableProcess, enableProcess, exportActorMapping, exportBarProcessContentUnderHome, getActivityDataDefinitions, getActor, getActorInitiator, getActorMembers, getActors, getActorsFromActorIds, getCategories, getCategoriesOfProcessDefinition, getCategoriesUnrelatedToProcessDefinition, getCategory, getConnectorImplementation, getConnectorImplementations, getDesignProcessDefinition, getLatestProcessDefinitionId, getNumberOfActivityDataDefinitions, getNumberOfActorMembers, getNumberOfActors, getNumberOfCategories, getNumberOfCategories, getNumberOfConnectorImplementations, getNumberOfGroupsOfActor, getNumberOfMembershipsOfActor, getNumberOfProcessDataDefinitions, getNumberOfProcessDefinitionsOfCategory, getNumberOfProcessDeploymentInfos, getNumberOfProcessDeploymentInfosUnrelatedToCategory, getNumberOfRolesOfActor, getNumberOfUncategorizedProcessDefinitions, getNumberOfUsersOfActor, getPossibleUsersOfHumanTask, getProcessDataDefinitions, getProcessDefinition, getProcessDefinitionId, getProcessDeploymentInfo, getProcessDeploymentInfos, getProcessDeploymentInfosFromArchivedProcessInstanceIds, getProcessDeploymentInfosFromIds, getProcessDeploymentInfosFromProcessInstanceIds, getProcessDeploymentInfosOfCategory, getProcessDeploymentInfosUnrelatedToCategory, getProcessDeploymentInfosWithActorOnlyForGroup, getProcessDeploymentInfosWithActorOnlyForGroups, getProcessDeploymentInfosWithActorOnlyForRole, getProcessDeploymentInfosWithActorOnlyForRoles, getProcessDeploymentInfosWithActorOnlyForUser, getProcessDeploymentInfosWithActorOnlyForUsers, getProcessResolutionProblems, getProcessResources, getStartableProcessDeploymentInfosForActors, getSupportedStates, getUncategorizedProcessDeploymentInfos, getUserIdsForActor, importActorMapping, importActorMapping, isAllowedToStartProcess, isUserProcessSupervisor, removeActorMember, removeAllCategoriesFromProcessDefinition, removeAllProcessDefinitionsFromCategory, removeCategoriesFromProcess, removeCategoriesFromProcessDefinition, removeProcessDefinitionsFromCategory, searchProcessDeploymentInfos, searchProcessDeploymentInfos, searchProcessDeploymentInfosCanBeStartedBy, searchProcessDeploymentInfosCanBeStartedByUsersManagedBy, searchProcessDeploymentInfosStartedBy, searchProcessDeploymentInfosSupervisedBy, searchProcessDeploymentInfosUsersManagedByCanStart, searchProcessSupervisors, searchUncategorizedProcessDeploymentInfos, searchUncategorizedProcessDeploymentInfosCanBeStartedBy, searchUncategorizedProcessDeploymentInfosSupervisedBy, searchUncategorizedProcessDeploymentInfosUserCanStart, searchUsersWhoCanStartProcessDefinition, updateActor, updateCategory, updateProcessDeploymentInfo
int getNumberOfParameterInstances(long processDefinitionId)
processDefinitionId
- The identifier of the processDefinitionInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ParameterInstance getParameterInstance(long processDefinitionId, String parameterName) throws ParameterNotFoundException
processDefinitionId
- The identifier of the processDefinitionparameterName
- The parameter name for get ParameterInstanceParameterNotFoundException
- Error thrown if the given parameter is not found.InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.List<ParameterInstance> getParameterInstances(long processDefinitionId, int startIndex, int maxResults, ParameterCriterion sort)
processDefinitionId
- The identifier of the processDefinitionstartIndex
- The index of the page to be returned. First page has index 0.maxResults
- The number of result per page. Maximum number of result returned.sort
- The criterion to sort the resultInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.void updateParameterInstanceValue(long processDefinitionId, String parameterName, String parameterValue) throws ParameterNotFoundException, UpdateException
processDefinitionId
- The identifier of the processDefinitionparameterName
- The parameter nameparameterValue
- The new value of the parameterParameterNotFoundException
- Error thrown if the given parameter is not found.UpdateException
- If the update cannot be fullfilled.InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.void importParameters(long processDefinitionId, byte[] parameters) throws ImportParameterException
processDefinitionId
- The identifier of the process definitionparameters
- The content of the properties file as a byte array. If null or empty byte[], nothing is done, and the process does not reset to unresolved but
stays the same.ImportParameterException
- If an exception occurs while importing the parametersInvalidSessionException
- If the session is invalid (expired, unknown, ...)List<ConnectorInstance> getConnectorInstancesOfActivity(long activityInstanceId, int startIndex, int maxResults, ConnectorInstanceCriterion sortingCriterion)
activityInstanceId
- The identifier of the element on which we want the connector instancesstartIndex
- The index of the page to be returned. First page has index 0.maxResults
- The number of result per page. Maximum number of result returned.sortingCriterion
- The criterion to sort the resultList<ConnectorInstance> getConnectorInstancesOfProcess(long processInstanceId, int startIndex, int maxResults, ConnectorInstanceCriterion sortingCriterion)
processInstanceId
- The identifier of the element on which we want the connector instancesstartIndex
- The index of the page to be returned. First page has index 0.maxResults
- The number of result per page. Maximum number of result returned.sortingCriterion
- The criterion to sort the resultvoid setConnectorInstanceState(long connectorInstanceId, ConnectorStateReset state) throws UpdateException, ConnectorInstanceNotFoundException
connectorInstanceId
- The identifier of the connector to changestate
- The state to set on the connectorUpdateException
- If the set operation cannot be fullfilled.ConnectorInstanceNotFoundException
- If the connector instance cannot be found with the provided connectorInstanceIdInvalidSessionException
- If no current valid engine session is foundvoid setConnectorInstanceState(Map<Long,ConnectorStateReset> connectorsToReset) throws ConnectorInstanceNotFoundException, UpdateException
connectorsToReset
- A Map containing, as key, the connector instance id, and as value, the ConnectorStateReset
value to reset the connector instance
to.ConnectorInstanceNotFoundException
- If the connector instance cannot be found with the provided connectorInstanceIdUpdateException
- If the set operation cannot be fullfilled.InvalidSessionException
- If no current valid engine session is foundvoid setConnectorImplementation(long processDefinitionId, String connectorName, String connectorVersion, byte[] connectorImplementationArchive) throws InvalidConnectorImplementationException, UpdateException
processDefinitionId
- The identifier of the process definition.connectorName
- The name of the connector.connectorVersion
- The version of the connector.connectorImplementationArchive
- The zipped .impl file contented as a byte array. The file is exported from studio.InvalidConnectorImplementationException
- If the implementation is not valid. (e.g. wrong format)UpdateException
- If the set operation cannot be fullfilled.InvalidSessionException
- If the session is invalid, e.g. the session has expired.void replayActivity(long activityInstanceId, Map<Long,ConnectorStateReset> connectorsToReset) throws ActivityInstanceNotFoundException, ActivityExecutionException
activityInstanceId
- The identifier of the activity instanceconnectorsToReset
- The map of connectors to reset before retrying the taskActivityInstanceNotFoundException
- If no activity instance can be found with the provided activityInstanceIdActivityExecutionException
- If the activity failed to replay.InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.void replayActivity(long activityInstanceId) throws ActivityInstanceNotFoundException, ActivityExecutionException
activityInstanceId
- The activity to replayActivityInstanceNotFoundException
- If no activity instance can be found with the provided activityInstanceIdActivityExecutionException
- If the activity failed to replay.InvalidSessionException
- When the activity can't be modifiedlong getNumberOfProcessSupervisorsForUser(long processDefinitionId)
userId
- The identifier of the usersearchOptions
- The search criteria.SearchException
- If an exception occurs when getting the processes supervisors.long getNumberOfProcessSupervisorsForGroup(long processDefinitionId)
groupId
- The identifier of the groupsearchOptions
- The search criteria.SearchException
- If an exception occurs when getting the processes supervisors.long getNumberOfProcessSupervisorsForRole(long processDefinitionId)
roleId
- The identifier of the rolesearchOptions
- The search criteria.SearchException
- If an exception occurs when getting the processes supervisors.long getNumberOfProcessSupervisorsForMembership(long processDefinitionId)
groupId
- The identifier of the grouproleId
- The identifier of the rolesearchOptions
- The search criteria.SearchException
- If an exception occurs when getting the processes supervisors.Copyright © 2014 Bonitasoft S.A.. All rights reserved.