public interface ProcessRuntimeAPI extends ProcessRuntimeAPI
ProcessRuntimeAPI
extends ProcessRuntimeAPI
and adds capabilities on Manual tasks, connector execution (directly
available at API level), search index updating.Modifier and Type | Method and Description |
---|---|
ManualTaskInstance |
addManualUserTask(ManualTaskCreator creator)
Add a manual task with given human task id.
|
void |
deleteManualUserTask(long manualTaskId)
Delete a manual task.
|
Map<String,Serializable> |
executeConnectorAtProcessInstantiation(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
List<Operation> operations,
Map<String,Serializable> operationsInputValues,
long processInstanceId)
Execute connector in given process instance initialized with operations.
|
Map<String,Serializable> |
executeConnectorAtProcessInstantiation(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
long processInstanceId)
Execute connector in given process instance initialized.
|
Map<String,Serializable> |
executeConnectorOnActivityInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
List<Operation> operations,
Map<String,Serializable> operationsInputValues,
long activityInstanceId)
Execute connector in given activity instance.
|
Map<String,Serializable> |
executeConnectorOnActivityInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
long activityInstanceId)
Execute connector in given activity instance.
|
Map<String,Serializable> |
executeConnectorOnCompletedActivityInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
List<Operation> operations,
Map<String,Serializable> operationsInputValues,
long activityInstanceId)
Execute connector in given activity instance finished.
|
Map<String,Serializable> |
executeConnectorOnCompletedActivityInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
long activityInstanceId)
Execute connector in given activity instance finished.
|
Map<String,Serializable> |
executeConnectorOnCompletedProcessInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
List<Operation> operations,
Map<String,Serializable> operationsInputValues,
long processInstanceId)
Execute connector in given process instance finished with operations.
|
Map<String,Serializable> |
executeConnectorOnCompletedProcessInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
long processInstanceId)
Execute connector in given process instance finished.
|
Map<String,Serializable> |
executeConnectorOnProcessInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
List<Operation> operations,
Map<String,Serializable> operationsInputValues,
long processInstanceId)
Execute connector in given process instance with operations
|
Map<String,Serializable> |
executeConnectorOnProcessInstance(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
long processInstanceId)
Execute connector in given process instance.
|
ConnectorInstanceWithFailureInfo |
getConnectorInstanceWithFailureInformation(long connectorInstanceId)
Retrieves a
ConnectorInstanceWithFailureInfo specified by its identifier. |
SearchResult<ArchivedActivityInstance> |
searchArchivedActivityInstancesSupervisedBy(long supervisorId,
SearchOptions searchOptions)
Search for archived flow node instances (activities, gateways and events) supervised by the specified user.
|
SearchResult<ArchivedFlowNodeInstance> |
searchArchivedFlowNodeInstancesSupervisedBy(long supervisorId,
SearchOptions searchOptions)
Search for archived flow node instances (activities, gateways and events) supervised by the specified user.
|
SearchResult<FlowNodeInstance> |
searchFlowNodeInstancesSupervisedBy(long supervisorId,
SearchOptions searchOptions)
Search for flow node instances (activities, gateways and events) supervised by the specified user.
|
ProcessInstance |
updateProcessInstance(long processInstanceId,
ProcessInstanceUpdater updater)
Update an instance of process with the given processInstanceId.
|
ProcessInstance |
updateProcessInstanceIndex(long processInstanceId,
Index index,
String value)
Update an index of a process instance.
|
addComment, addProcessComment, assignUserTask, cancelProcessInstance, canExecuteTask, countAttachments, countComments, deleteArchivedProcessInstances, deleteProcessInstance, deleteProcessInstances, deleteProcessInstances, evaluateExpressionOnCompletedProcessInstance, evaluateExpressionOnProcessDefinition, evaluateExpressionsAtProcessInstanciation, evaluateExpressionsOnActivityInstance, evaluateExpressionsOnCompletedActivityInstance, evaluateExpressionsOnProcessDefinition, evaluateExpressionsOnProcessInstance, executeConnectorOnProcessDefinition, executeConnectorOnProcessDefinition, executeFlowNode, executeFlowNode, getActivities, getActivityDataInstance, getActivityDataInstances, getActivityInstance, getActivityInstanceState, getActivityReachedStateDate, getActivityTransientDataInstance, getActivityTransientDataInstances, getArchivedActivityDataInstance, getArchivedActivityDataInstances, getArchivedActivityInstance, getArchivedActivityInstances, getArchivedComment, getArchivedFlowNodeInstance, getArchivedProcessDataInstance, getArchivedProcessDataInstances, getArchivedProcessInstance, getArchivedProcessInstances, getArchivedProcessInstances, getAssignedHumanTaskInstances, getChildrenInstanceIdsOfProcessInstance, getComments, getEventInstances, getFailedJobs, getFinalArchivedProcessInstance, getFlowNodeInstance, getHumanTaskInstance, getHumanTaskInstances, getLastStateHumanTaskInstance, getNumberOfActivityDataInstances, getNumberOfArchivedProcessInstances, getNumberOfAssignedHumanTaskInstances, getNumberOfOpenedActivityInstances, getNumberOfOpenTasks, getNumberOfOverdueOpenTasks, getNumberOfPendingHumanTaskInstances, getNumberOfProcessDataInstances, getNumberOfProcessInstances, getOneAssignedUserTaskInstanceOfProcessDefinition, getOneAssignedUserTaskInstanceOfProcessInstance, getOpenActivityInstances, getPendingHumanTaskInstances, getPossibleUsersOfPendingHumanTask, getProcessDataInstance, getProcessDataInstances, getProcessDefinitionIdFromActivityInstanceId, getProcessDefinitionIdFromProcessInstanceId, getProcessInstance, getProcessInstanceIdFromActivityInstanceId, getProcessInstances, hideTasks, isInvolvedInProcessInstance, isTaskHidden, releaseUserTask, replayFailedJob, replayFailedJob, retryTask, searchActivities, searchArchivedActivities, searchArchivedComments, searchArchivedConnectorInstances, searchArchivedFlowNodeInstances, searchArchivedHumanTasks, searchArchivedHumanTasksManagedBy, searchArchivedHumanTasksSupervisedBy, searchArchivedProcessInstances, searchArchivedProcessInstancesInAllStates, searchArchivedProcessInstancesInvolvingUser, searchArchivedProcessInstancesSupervisedBy, searchAssignedAndPendingHumanTasks, searchAssignedAndPendingHumanTasksFor, searchAssignedTasksManagedBy, searchAssignedTasksSupervisedBy, searchComments, searchCommentsInvolvingUser, searchCommentsManagedBy, searchConnectorInstances, searchFlowNodeInstances, searchHumanTaskInstances, searchMyAvailableHumanTasks, searchOpenProcessInstances, searchOpenProcessInstancesInvolvingUser, searchOpenProcessInstancesInvolvingUsersManagedBy, searchOpenProcessInstancesSupervisedBy, searchPendingHiddenTasks, searchPendingTasksForUser, searchPendingTasksManagedBy, searchPendingTasksSupervisedBy, searchProcessDeploymentInfosWithAssignedOrPendingHumanTasks, searchProcessDeploymentInfosWithAssignedOrPendingHumanTasksFor, searchProcessDeploymentInfosWithAssignedOrPendingHumanTasksSupervisedBy, searchProcessInstances, searchUsersWhoCanExecutePendingHumanTask, sendMessage, sendMessage, sendSignal, setActivityStateById, setActivityStateByName, setProcessInstanceState, setTaskPriority, startProcess, startProcess, startProcess, startProcess, startProcess, startProcess, unhideTasks, updateActivityDataInstance, updateActivityInstanceVariables, updateActivityInstanceVariables, updateActivityTransientDataInstance, updateActorsOfUserTask, updateDueDateOfTask, updateProcessDataInstance, updateProcessDataInstances
ManualTaskInstance addManualUserTask(ManualTaskCreator creator) throws CreationException, AlreadyExistsException
creator
- the manual task creatorCreationException
- if the manual task cannot be created.AlreadyExistsException
- if the provided manual task already exists.InvalidSessionException
- if the session is invalid, e.g. the session has expired.void deleteManualUserTask(long manualTaskId) throws DeletionException
manualTaskId
- the id of the task to deleteDeletionException
- if the manual task could not be deleted.InvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorAtProcessInstantiation(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evaluate the connectorprocessInstanceId
- Identifier of the process instanceConnectorExecutionException
- if an error occurs when trying to execute the connectorConnectorNotFoundException
- if the specified connector is not foundInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorAtProcessInstantiation(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long processInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evaluate the connectoroperations
- map of operations having each a special context (input values)operationsInputValues
- all parameters values for operationsprocessInstanceId
- Identifier of the process instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long activityInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectoractivityInstanceId
- Identifier of the activity instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long activityInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evaluate the connectoroperations
- map of operations having each a special context (input values)operationsInputValues
- the map of input name-value pairs used by operation executions.activityInstanceId
- Identifier of the activity instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnCompletedActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long activityInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectoractivityInstanceId
- Identifier of the activity instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnCompletedActivityInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long activityInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectoroperations
- map of operations having each a special context (input values)operationsInputValues
- the map of input name-value pairs used by operation executions.activityInstanceId
- Identifier of the activity instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnCompletedProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectorprocessInstanceId
- Identifier of the process instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnCompletedProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long processInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectoroperations
- map of operations having each a special context (input values)operationsInputValues
- the map of input name-value pairs used by operation executions.processInstanceId
- Identifier of the process instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectorprocessInstanceId
- Identifier of the process instanceConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnProcessInstance(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationsInputValues, long processInstanceId) throws ConnectorExecutionException, ConnectorNotFoundException
connectorDefinitionId
- Identifier of connector definitionconnectorDefinitionVersion
- version of the connector definitionconnectorInputParameters
- all expressions related with the connectorinputValues
- all parameters values for expression need when evalute the connectorprocessInstanceId
- Identifier of the process instanceoperations
- map of operations having each a special context (input values)operationsInputValues
- the map of input name-value pairs used by operation executions.ConnectorExecutionException
- if the connector failed to execute properly.ConnectorNotFoundException
- if the connector cannot be found with the provided connectorDefinitionId + connectorDefinitionVersionInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessInstance updateProcessInstanceIndex(long processInstanceId, Index index, String value) throws ProcessInstanceNotFoundException, UpdateException
processInstanceId
- identifier of the process instanceindex
- which index to updatevalue
- the new value for the indexProcessInstanceNotFoundException
- Error thrown if no process instance have an id corresponding to the value of processInstanceId parameter.UpdateException
- if an error is thrown while updating the process instance.InvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessInstance updateProcessInstance(long processInstanceId, ProcessInstanceUpdater updater) throws ProcessInstanceNotFoundException, UpdateException
processInstanceId
- Identifier of the process instanceupdater
- including new value of all attributes adaptableProcessInstanceNotFoundException
- Error thrown if no process instance have an id corresponding to the value of processInstanceId parameter.UpdateException
- if an error is thrown while updating the process instance.InvalidSessionException
- if the session is invalid, e.g. the session has expired.ConnectorInstanceWithFailureInfo getConnectorInstanceWithFailureInformation(long connectorInstanceId) throws ConnectorInstanceNotFoundException
ConnectorInstanceWithFailureInfo
specified by its identifier.connectorInstanceId
- the identifier of the ConnectorInstanceWithFailureInfo
to be retrieved.ConnectorInstanceWithFailureInfo
instance.ConnectorInstanceNotFoundException
- if no ConnectorInstanceWithFailureInfo
is found with the specified connectorInstanceId.SearchResult<ArchivedFlowNodeInstance> searchArchivedFlowNodeInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) throws SearchException
supervisorId
- The identifier of the supervising user.searchOptions
- The search options (pagination, filter, order sort).SearchResult
containing the search result.InvalidSessionException
- If the session is invalid, e.g. the session has expired.SearchException
- If the search could not be completed correctly.SearchResult<ArchivedActivityInstance> searchArchivedActivityInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) throws SearchException
supervisorId
- The identifier of the supervising user.searchOptions
- The search options (pagination, filter, order sort).SearchResult
containing the search result.InvalidSessionException
- If the session is invalid, e.g. the session has expired.SearchException
- If the search could not be completed correctly.SearchResult<FlowNodeInstance> searchFlowNodeInstancesSupervisedBy(long supervisorId, SearchOptions searchOptions) throws SearchException
supervisorId
- The identifier of the supervising user.searchOptions
- The search options (pagination, filter, order sort).SearchResult
containing the search result.InvalidSessionException
- If the session is invalid, e.g. the session has expired.SearchException
- If the search could not be completed correctly.Copyright © 2014 Bonitasoft S.A.. All rights reserved.