public interface ProcessRuntimeAPI
Modifier and Type | Method and Description |
---|---|
Comment |
addComment(long processInstanceId,
String comment)
Add a comment on a process instance
|
void |
assignUserTask(long userTaskId,
long userId)
Assign a task to a user with given user name.
|
void |
cancelProcessInstance(long processInstanceId)
Cancel an instance of process with the given processInstanceId.
|
boolean |
canExecuteTask(long activityInstanceId,
long userId)
Check if the task can be executed
|
long |
countAttachments(SearchOptions searchOptions)
Query the engine to get the number of attachments depending on the search options
|
long |
countComments(SearchOptions searchOptions)
Query the engine to get the number of comments depending on the search options
|
void |
deleteProcessInstance(long processInstanceId)
Delete the process instance having the identifier in parameter
|
void |
deleteProcessInstances(long processDefinitionId)
Delete process instances by its process definition id
If process having the id is not found, it will thrown ProcessDefinitionNotFoundException
If process having the id is enabled, it will thrown DeletingEnabledProcessException
|
Map<String,Serializable> |
evaluateExpressionOnCompletedProcessInstance(long processInstanceId,
Map<Expression,Map<String,Serializable>> expressions)
Evaluate expressions with values valid on a completed process instance scope.
|
Serializable |
evaluateExpressionOnProcessDefinition(Expression expression,
Map<String,Serializable> context,
long processDefinitionId)
Evaluate the expression in the context of the process having the processDefinitionId.
|
Map<String,Serializable> |
evaluateExpressionsAtProcessInstanciation(long processInstanceId,
Map<Expression,Map<String,Serializable>> expressions)
Evaluate expressions with values valid at process instantiation scope.
|
Map<String,Serializable> |
evaluateExpressionsOnActivityInstance(long activityInstanceId,
Map<Expression,Map<String,Serializable>> expressions)
Evaluate expressions with values valid on an activity instance scope.
|
Map<String,Serializable> |
evaluateExpressionsOnCompletedActivityInstance(long activityInstanceId,
Map<Expression,Map<String,Serializable>> expressions)
Evaluate expressions with values valid on a completed activity instance scope.
|
Map<String,Serializable> |
evaluateExpressionsOnProcessDefinition(long processDefinitionId,
Map<Expression,Map<String,Serializable>> expressions)
Evaluate expressions with values valid on a process definition scope.
|
Map<String,Serializable> |
evaluateExpressionsOnProcessInstance(long processInstanceId,
Map<Expression,Map<String,Serializable>> expressions)
Evaluate expressions with values valid on a process instance scope.
|
Map<String,Serializable> |
executeConnectorOnProcessDefinition(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
List<Operation> operations,
Map<String,Serializable> operationInputValues,
long processDefinitionId)
Execute connector in given processDefinition with operations.
|
Map<String,Serializable> |
executeConnectorOnProcessDefinition(String connectorDefinitionId,
String connectorDefinitionVersion,
Map<String,Expression> connectorInputParameters,
Map<String,Map<String,Serializable>> inputValues,
long processDefinitionId)
Execute connector in given processDefinition.
|
void |
executeFlowNode(long flownodeInstanceId)
Execute an activity that is is a non stable state
Will make the activity go in the next stable state and then continue the execution of the process
|
List<ActivityInstance> |
getActivities(long processInstanceId,
int startIndex,
int maxResults)
Returns all activities (active and finished) of a process instance.
|
DataInstance |
getActivityDataInstance(String dataName,
long activityInstanceId)
Get a data instance in activity with data name and activity instance id.
|
List<DataInstance> |
getActivityDataInstances(long activityInstanceId,
int startIndex,
int maxResults)
Get data instances under the activity with given activity id.
|
ActivityInstance |
getActivityInstance(long activityInstanceId)
Get an instance of activity using its activity instance id.
|
String |
getActivityInstanceState(long activityInstanceId)
Get an activity instance's state according to its activityInstanceId.
|
Date |
getActivityReachedStateDate(long activityInstanceId,
String state)
Get the date when the activity with given activityInstanceId reaches the given state.
|
ArchivedActivityInstance |
getArchivedActivityInstance(long activityInstanceId)
Get an activity instance that already was archived.
|
List<ArchivedActivityInstance> |
getArchivedActivityInstances(long processInstanceId,
int startIndex,
int maxResults,
ActivityInstanceCriterion criterion)
Get a list of archived activity instances, the returned list is paginated
|
ArchivedComment |
getArchivedComment(long archivedCommentId)
Retrieves an
ArchivedComment from its id. |
ArchivedFlowNodeInstance |
getArchivedFlowNodeInstance(long archivedFlowNodeInstanceId)
Retrieves an
ArchivedFlowNodeInstance from its id. |
ArchivedProcessInstance |
getArchivedProcessInstance(long archivedProcessInstanceId)
Retrieves an
ArchivedProcessInstance from its id. |
List<ArchivedProcessInstance> |
getArchivedProcessInstances(int startIndex,
int maxResults,
ProcessInstanceCriterion criterion)
Get all archived process instances, the returned list is paginated
|
List<ArchivedProcessInstance> |
getArchivedProcessInstances(long processInstanceId,
int startIndex,
int maxResults) |
List<HumanTaskInstance> |
getAssignedHumanTaskInstances(long userId,
int startIndex,
int maxResults,
ActivityInstanceCriterion criterion)
Retrieve a list of assigned human task instances related to given userId.
|
List<Long> |
getChildrenInstanceIdsOfProcessInstance(long processInstanceId,
int startIndex,
int maxResults,
ProcessInstanceCriterion criterion)
Get the children instances (sub process or call activity) of a process instance.
|
List<Comment> |
getComments(long processInstanceId)
Get all comments by its process instance id
|
List<EventInstance> |
getEventInstances(long rootContainerId,
int startIndex,
int maxResults,
EventCriterion sortingType)
Get a event instance list according to all given conditions
|
ArchivedProcessInstance |
getFinalArchivedProcessInstance(long processInstanceId)
Get the last archived instance of process.
|
FlowNodeInstance |
getFlowNodeInstance(long flowNodeInstanceId)
Get an instance of flow node using its flow node instance id.
|
HumanTaskInstance |
getHumanTaskInstance(long activityInstanceId)
Retrieve a human task instance using corresponding activity instance id.
|
List<HumanTaskInstance> |
getHumanTaskInstances(long processInstanceId,
String taskName,
int startIndex,
int maxResults)
Get all tasks having given name and belonging to the process instance having given id
|
HumanTaskInstance |
getLastStateHumanTaskInstance(long processInstanceId,
String taskName)
Returns the last created HumanTask, in the given process instance, named taskName
|
long |
getNumberOfActivityDataInstances(long activityInstanceId)
Get number of all activity data instances by id
|
long |
getNumberOfArchivedProcessInstances()
Get the number of distinct archived process instances.
|
long |
getNumberOfAssignedHumanTaskInstances(long userId)
Count total number of human task instances assigned that is related to the given userId.
|
int |
getNumberOfOpenedActivityInstances(long processInstanceId)
Get total number of open activity instances by its id
|
Map<Long,Long> |
getNumberOfOpenTasks(List<Long> userIds)
Return userIds and corresponding open task's id.
|
Map<Long,Long> |
getNumberOfOverdueOpenTasks(List<Long> userIds)
Get the number of both assigned and pending overdue tasks for each user
|
long |
getNumberOfPendingHumanTaskInstances(long userId)
Count number of pending human task instances.
|
long |
getNumberOfProcessDataInstances(long processInstanceId)
Get number of all process data instances by id
|
long |
getNumberOfProcessInstances()
Get the number of running process instances.
|
long |
getOneAssignedUserTaskInstanceOfProcessDefinition(long processDefinitionId,
long userId)
Get an instance of userTask assigned in a processDefinition.
|
long |
getOneAssignedUserTaskInstanceOfProcessInstance(long processInstanceId,
long userId)
Get an instance of userTask assigned in an instance of process.
|
List<ActivityInstance> |
getOpenActivityInstances(long processInstanceId,
int startIndex,
int maxResults,
ActivityInstanceCriterion criterion)
Retrieve a list of open activities for a given process instance, the returned list is paginated
|
List<HumanTaskInstance> |
getPendingHumanTaskInstances(long userId,
int startIndex,
int maxResults,
ActivityInstanceCriterion pagingCriterion)
Retrieve a list of pending human task instances related to a given userId.
|
DataInstance |
getProcessDataInstance(String dataName,
long processInstanceId)
Get a DataInstance by dataName, processInstanceId.
|
List<DataInstance> |
getProcessDataInstances(long processInstanceId,
int startIndex,
int maxResults)
Returns all data of a process instance
|
long |
getProcessDefinitionIdFromActivityInstanceId(long activityInstanceId)
Get process definition id from its activity instance id
|
long |
getProcessDefinitionIdFromProcessInstanceId(long processInstanceId)
Get process definition id from its process instance id
|
ProcessInstance |
getProcessInstance(long processInstanceId)
Get an instance of process with its processInstance id.
|
long |
getProcessInstanceIdFromActivityInstanceId(long activityInstanceId)
Get process instance id from its activity instance id
|
List<ProcessInstance> |
getProcessInstances(int startIndex,
int maxResults,
ProcessInstanceCriterion criterion)
Get all process instances, the returned list is paginated
|
void |
hideTasks(long userId,
Long... activityInstanceId)
Hides a list of tasks from a specified user.
|
boolean |
isInvolvedInProcessInstance(long userId,
long processInstanceId)
Whether or not a user is involved in an instance of process (has tasks pending?)
|
boolean |
isTaskHidden(long userTaskId,
long userId)
return true if the task have the identifier userTaskId is hidden for the logged user
|
void |
releaseUserTask(long userTaskId)
release a task (un_claim or un_assign).
|
void |
retryTask(long activityInstanceId)
set state of activity to its previous state and then execute.
|
SearchResult<ActivityInstance> |
searchActivities(SearchOptions searchOptions)
Searches for activity instances
|
SearchResult<ArchivedActivityInstance> |
searchArchivedActivities(SearchOptions searchOptions)
Searches for archived activity instances (only terminal states, intermediate states are not considered)
|
SearchResult<ArchivedComment> |
searchArchivedComments(SearchOptions searchOptions)
Searches for archived comments
|
SearchResult<ArchivedConnectorInstance> |
searchArchivedConnectorInstances(SearchOptions searchOptions)
Searches for archived connector instances.
|
SearchResult<ArchivedFlowNodeInstance> |
searchArchivedFlowNodeInstances(SearchOptions searchOptions)
Searches for archived flow node instances (activities, gateways and events)
|
SearchResult<ArchivedHumanTaskInstance> |
searchArchivedHumanTasks(SearchOptions searchOptions)
Search task archived.
|
SearchResult<ArchivedHumanTaskInstance> |
searchArchivedHumanTasksManagedBy(long managerUserId,
SearchOptions searchOptions)
Searches for archived human tasks performed by users managed by a specific user
|
SearchResult<ArchivedHumanTaskInstance> |
searchArchivedHumanTasksSupervisedBy(long supervisorId,
SearchOptions searchOptions)
Searches archived tasks assigned to users supervised by a specific user.
|
SearchResult<ArchivedProcessInstance> |
searchArchivedProcessInstances(SearchOptions searchOptions)
Searches for archived process instances
|
SearchResult<ArchivedProcessInstance> |
searchArchivedProcessInstancesInvolvingUser(long userId,
SearchOptions searchOptions)
Searches for the archived process instances that the user can access
|
SearchResult<ArchivedProcessInstance> |
searchArchivedProcessInstancesSupervisedBy(long userId,
SearchOptions searchOptions)
Searches for archived process instances supervised by a user
|
SearchResult<HumanTaskInstance> |
searchAssignedTasksManagedBy(long managerUserId,
SearchOptions searchOptions)
Search human tasks administered by the given user.
|
SearchResult<HumanTaskInstance> |
searchAssignedTasksSupervisedBy(long supervisorId,
SearchOptions searchOptions)
Searches tasks assigned to users supervised by a specific user.
|
SearchResult<Comment> |
searchComments(SearchOptions searchOptions)
Searches for comments related to the specified Process Instance.
|
SearchResult<Comment> |
searchCommentsInvolvingUser(long userId,
SearchOptions searchOptions)
Searches the comments on process instances that the user can access
|
SearchResult<Comment> |
searchCommentsManagedBy(long managerUserId,
SearchOptions searchOptions)
Lists all comments managed by user.
|
SearchResult<ConnectorInstance> |
searchConnectorInstances(SearchOptions searchOptions)
Searches for connector instances.
|
SearchResult<FlowNodeInstance> |
searchFlowNodeInstances(SearchOptions searchOptions)
Searches for flow node instances (activities, gateways and events)
|
SearchResult<HumanTaskInstance> |
searchHumanTaskInstances(SearchOptions searchOptions)
Searches for humanTask instances
|
SearchResult<HumanTaskInstance> |
searchMyAvailableHumanTasks(long userId,
SearchOptions searchOptions)
Searches, for a specific user, for all tasks pending for that user, or already assigned to that user.
|
SearchResult<ProcessInstance> |
searchOpenProcessInstances(SearchOptions searchOptions)
List all open process instances
|
SearchResult<ProcessInstance> |
searchOpenProcessInstancesInvolvingUser(long userId,
SearchOptions searchOptions)
Searches for open process instances that the user can access
|
SearchResult<ProcessInstance> |
searchOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId,
SearchOptions searchOptions)
Searches for open process instances that all subordinates of the specific manager can access
|
SearchResult<ProcessInstance> |
searchOpenProcessInstancesSupervisedBy(long userId,
SearchOptions searchOptions)
List all open process instances supervised by a user.
|
SearchResult<HumanTaskInstance> |
searchPendingHiddenTasks(long userId,
SearchOptions searchOptions)
Search for the hidden tasks for the specified user.
|
SearchResult<HumanTaskInstance> |
searchPendingTasksForUser(long userId,
SearchOptions searchOptions)
Search pending human tasks for the given user.
|
SearchResult<HumanTaskInstance> |
searchPendingTasksManagedBy(long managerUserId,
SearchOptions searchOptions)
Search pending human tasks administered by the given user.
|
SearchResult<HumanTaskInstance> |
searchPendingTasksSupervisedBy(long userId,
SearchOptions searchOptions)
Search pending human tasks supervised by the given user.
|
void |
sendMessage(String messageName,
Expression targetProcess,
Expression targetFlowNode,
Map<Expression,Expression> messageContent)
Send a BPMN message event.
|
void |
sendMessage(String messageName,
Expression targetProcess,
Expression targetFlowNode,
Map<Expression,Expression> messageContent,
Map<Expression,Expression> correlations)
Send a BPMN message event.
|
void |
sendSignal(String signalName)
Send a BPMN signal event.
|
void |
setActivityStateById(long activityInstanceId,
int stateId)
Set a activity's state with state id.
|
void |
setActivityStateByName(long activityInstanceId,
String state)
Set a activity's state with state name.
|
void |
setProcessInstanceState(ProcessInstance processInstance,
String state)
Set a process instance's state.
|
void |
setTaskPriority(long userTaskInstanceId,
TaskPriority priority)
Set this userTask instance's priority.
|
ProcessInstance |
startProcess(long processDefinitionId)
Start an instance of the process definition having processDefinitionId, and using the current session user
|
ProcessInstance |
startProcess(long processDefinitionId,
List<Operation> operations,
Map<String,Serializable> context)
Start a process by process definition id
|
ProcessInstance |
startProcess(long userId,
long processDefinitionId)
Start the process on behalf of a given user name
|
ProcessInstance |
startProcess(long userId,
long processDefinitionId,
List<Operation> operations,
Map<String,Serializable> context)
Start an instance of the process definition on behalf of a given user, and set the initial values of the data with the given operations.
|
void |
unhideTasks(long userId,
Long... activityInstanceId)
Un-hides a list of tasks from a specified user.
|
void |
updateActivityDataInstance(String dataName,
long activityInstanceId,
Serializable dataValue)
Update a data instance's value which in activity using data name and activity instance id.
|
void |
updateActivityInstanceVariables(List<Operation> operations,
long activityInstanceId,
Map<String,Serializable> expressionContexts)
Update a variable data's expression in an activity instance which has left and right sides.
|
void |
updateActivityInstanceVariables(long activityInstanceId,
Map<String,Serializable> variables)
Update the given variables of an activity instance.
|
void |
updateDueDateOfTask(long userTaskId,
Date dueDate)
Update the due date of a task
|
void |
updateProcessDataInstance(String dataName,
long processInstanceId,
Serializable dataValue)
Update data instance with given data name, value and process instance id that the data belongs to.
|
SearchResult<HumanTaskInstance> searchPendingHiddenTasks(long userId, SearchOptions searchOptions) throws SearchException
userId
- the ID of the user for whom to retrieve the hidden taskssearchOptions
- the search options parametersSearchException
- in case a search problem occursSearchResult<ProcessInstance> searchOpenProcessInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- The criterion used to search process instanceSearchException
- The search failedSearchResult<ProcessInstance> searchOpenProcessInstancesSupervisedBy(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of the usersearchOptions
- The criterion used to search process instanceSearchException
- The search failedlong getNumberOfProcessDataInstances(long processInstanceId) throws ProcessInstanceNotFoundException
processInstanceId
- Identifier of the activity instanceProcessInstanceNotFoundException
- Error thrown if no ProcessInstance have an id corresponding to the parameter.long getNumberOfActivityDataInstances(long activityInstanceId) throws ActivityInstanceNotFoundException
activityInstanceId
- Identifier of the activity instanceActivityInstanceNotFoundException
- Error thrown if no activity instance have an id corresponding to the parameter.List<ProcessInstance> getProcessInstances(int startIndex, int maxResults, ProcessInstanceCriterion criterion)
startIndex
- Index of the page to be returned. First page has index 0.maxResults
- Number of documents per page. Maximum number of documents returned.criterion
- the criterion for sort result.InvalidSessionException
- if the session is invalid, e.g. the session has expired.List<ArchivedProcessInstance> getArchivedProcessInstances(int startIndex, int maxResults, ProcessInstanceCriterion criterion)
startIndex
- Index of the page to be returned. First page has index 0.maxResults
- Number of result per page. Maximum number of result returned.criterion
- the criterion for sort result.List<ArchivedActivityInstance> getArchivedActivityInstances(long processInstanceId, int startIndex, int maxResults, ActivityInstanceCriterion criterion)
processInstanceId
- Identifier of the process instancestartIndex
- Index of the page to be returned. First page has index 0.maxResults
- Number of result per page. Maximum number of result returned.criterion
- aging criterion to sort the resultsList<ActivityInstance> getOpenActivityInstances(long processInstanceId, int startIndex, int maxResults, ActivityInstanceCriterion criterion)
processInstanceId
- Identifier of the process instancestartIndex
- Index of the page to be returned. First page has index 0.maxResults
- Number of result per page. Maximum number of result returned.criterion
- paging criterion to sort the resultsint getNumberOfOpenedActivityInstances(long processInstanceId) throws ProcessInstanceNotFoundException
processInstanceId
- Identifier of the process instanceProcessInstanceNotFoundException
long getNumberOfProcessInstances()
long getNumberOfArchivedProcessInstances()
void deleteProcessInstance(long processInstanceId) throws DeletionException
processInstanceId
- identifier of the process instance to deleteProcessInstanceHierarchicalDeletionException
- if a process instance can't be deleted because of a parent that is still activeDeletionException
void deleteProcessInstances(long processDefinitionId) throws DeletionException
processDefinitionId
- Identifier of the processDefinitionProcessInstanceHierarchicalDeletionException
- if a process instance can't be deleted because of a parent that is still activeDeletionException
ProcessInstance startProcess(long processDefinitionId) throws ProcessDefinitionNotFoundException, ProcessActivationException, ProcessExecutionException
processDefinitionId
- Identifier of the process definition will be startedProcessDefinitionNotFoundException
- No matching process definition foundProcessActivationException
- if the process is disabledProcessExecutionException
- The process failed to executeProcessInstance startProcess(long processDefinitionId, List<Operation> operations, Map<String,Serializable> context) throws ProcessDefinitionNotFoundException, ProcessActivationException, ProcessExecutionException, ProcessDefinitionNotFoundException
processDefinitionId
- Identifier of the processDefinitionoperations
- The operations to start processcontext
- The context in which operations are executedExecutionException
- The process failed to startProcessDefinitionNotFoundException
- The process definition corresponding to processDefinitionId is not foundProcessExecutionException
ProcessDefinitionNotFoundException
ProcessActivationException
- if the process is disabledProcessInstance startProcess(long userId, long processDefinitionId) throws UserNotFoundException, ProcessDefinitionNotFoundException, ProcessActivationException, ProcessExecutionException
userId
- the user id of the user starting the processprocessDefinitionId
- Identifier of the processDefinitionProcessActivationException
- if the process is disabledUserNotFoundException
ProcessDefinitionNotFoundException
ProcessExecutionException
ProcessInstance startProcess(long userId, long processDefinitionId, List<Operation> operations, Map<String,Serializable> context) throws UserNotFoundException, ProcessDefinitionNotFoundException, ProcessActivationException, ProcessExecutionException
userId
- the id of the user to start the process on behalf ofprocessDefinitionId
- Identifier of the process definition will be startedoperations
- the operations to execute to set the initial values of the datacontext
- TODOInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessDefinitionNotFoundException
- No matching process definition foundProcessActivationException
- a primary precondition of starting a process is the status of matching process definition should be enabled, if not,the exception occur.UserNotFoundException
- in case this userId is not found.ProcessExecutionException
- if a problem occurs when starting the processvoid executeFlowNode(long flownodeInstanceId) throws FlowNodeExecutionException
flownodeInstanceId
- id of the flow node to executeFlowNodeExecutionException
- if an execution exception occursList<ActivityInstance> getActivities(long processInstanceId, int startIndex, int maxResults)
processInstanceId
- Identifier of the process instancestartIndex
- the indexmaxResults
- the number of results to getProcessInstance getProcessInstance(long processInstanceId) throws ProcessInstanceNotFoundException
processInstanceId
- Identifier of the process instanceProcessInstanceNotFoundException
ActivityInstance getActivityInstance(long activityInstanceId) throws ActivityInstanceNotFoundException
activityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ActivityInstanceNotFoundException
- if the activity cannot be foundRetrieveException
- can't retrieve an instance of activityFlowNodeInstance getFlowNodeInstance(long flowNodeInstanceId) throws FlowNodeInstanceNotFoundException
flowNodeInstanceId
- Identifier of the flow node instanceFlowNodeInstanceNotFoundException
ArchivedActivityInstance getArchivedActivityInstance(long activityInstanceId) throws ActivityInstanceNotFoundException
activityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ActivityInstanceNotFoundException
- if the archived activity cannot be foundRetrieveException
- can't retrieve an instance of activityList<HumanTaskInstance> getAssignedHumanTaskInstances(long userId, int startIndex, int maxResults, ActivityInstanceCriterion criterion)
userId
- the user identifierstartIndex
- the indexmaxResults
- the max number of elements to retrieve per pagecriterion
- the sort criterionInvalidSessionException
- occurs when the session is invalid.RetrieveException
- can't retrieve an instance of activityList<HumanTaskInstance> getPendingHumanTaskInstances(long userId, int startIndex, int maxResults, ActivityInstanceCriterion pagingCriterion)
ActorMember
or through a UserFilter
. In addition, hidden tasks for this user are not retrieved (see
hideTasks(long, Long...)
)userId
- the user identifierstartIndex
- the indexmaxResults
- the max number of elements to retrieve per pagepagingCriterion
- the Criterion is for how to separate all items gotten to many pages.InvalidSessionException
- occurs when the session is invalid.long getNumberOfAssignedHumanTaskInstances(long userId)
userId
- Identifier of a userInvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- errors happen in while retrieving the instance of activityMap<Long,Long> getNumberOfOpenTasks(List<Long> userIds)
userIds
- a list of Identifiers for usersInvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- can't retrieve an instance of activitylong getNumberOfPendingHumanTaskInstances(long userId)
userId
- Identifier of a userInvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- errors happen in while retrieving the instance of activityHumanTaskInstance getHumanTaskInstance(long activityInstanceId) throws ActivityInstanceNotFoundException
activityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ActivityInstanceNotFoundException
- if the human task cannot be foundRetrieveException
- errors happen in while retrieving the instance of activityList<EventInstance> getEventInstances(long rootContainerId, int startIndex, int maxResults, EventCriterion sortingType)
rootContainerId
- id of the top-level containerstartIndex
- the indexmaxResults
- the number of results to getInvalidSessionException
- if the session is invalid, e.g. the session has expired.void assignUserTask(long userTaskId, long userId) throws UpdateException
userTaskId
- Identifier of user taskuserId
- id of userInvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
List<DataInstance> getProcessDataInstances(long processInstanceId, int startIndex, int maxResults)
processInstanceId
- Identifier of the process instancestartIndex
- the index of the page of results to getmaxResults
- the number of results to getDataInstance getProcessDataInstance(String dataName, long processInstanceId) throws DataNotFoundException
dataName
- name of dataprocessInstanceId
- Identifier of the process instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.DataNotFoundException
- Error thrown if can't get the corresponding data.void updateProcessDataInstance(String dataName, long processInstanceId, Serializable dataValue) throws UpdateException
dataName
- name of dataprocessInstanceId
- Identifier of process instance the data belongs todataValue
- the new value of data to setInvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
- if an data update problem occursList<DataInstance> getActivityDataInstances(long activityInstanceId, int startIndex, int maxResults)
activityInstanceId
- Identifier of the activity instancestartIndex
- the indexmaxResults
- the number of results to getDataInstance getActivityDataInstance(String dataName, long activityInstanceId) throws DataNotFoundException
dataName
- name of dataactivityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.DataNotFoundException
- Error thrown if can't get the corresponding data.void updateActivityDataInstance(String dataName, long activityInstanceId, Serializable dataValue) throws UpdateException
dataName
- name of dataactivityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
Date getActivityReachedStateDate(long activityInstanceId, String state)
activityInstanceId
- Identifier of the activity instancestate
- representing state of the activity existedInvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- errors happen in while retrieving the instance of activityvoid updateActivityInstanceVariables(long activityInstanceId, Map<String,Serializable> variables) throws UpdateException
activityInstanceId
- the activity identifiervariables
- a map which contains several couple the variable name/valueInvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
void updateActivityInstanceVariables(List<Operation> operations, long activityInstanceId, Map<String,Serializable> expressionContexts) throws UpdateException
operations
- using this parameter to update expression's left and right side for different operation type.activityInstanceId
- Identifier of the activity instanceexpressionContexts
- store all parameters that related to container which the data belongs to.InvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
void updateDueDateOfTask(long userTaskId, Date dueDate) throws UpdateException
userTaskId
- identifier of the task to updatedueDate
- new due date for the taskInvalidSessionException
- if the activity does not existsUpdateException
long getOneAssignedUserTaskInstanceOfProcessInstance(long processInstanceId, long userId) throws ProcessInstanceNotFoundException, UserNotFoundException
processInstanceId
- Identifier of the process instanceuserId
- Identifier of a userInvalidSessionException
- if the session is invalid, e.g. the session has expired.UserNotFoundException
- Error thrown if no user have an id corresponding to the value of userId parameterRetrieveException
- errors happen in while retrieving the instance of activityProcessInstanceNotFoundException
long getOneAssignedUserTaskInstanceOfProcessDefinition(long processDefinitionId, long userId) throws ProcessDefinitionNotFoundException, UserNotFoundException
processDefinitionId
- Identifier of the process definitionuserId
- Identifier of a userInvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- Error thrown if can't retrieve corresponding instance of process.ProcessDefinitionNotFoundException
UserNotFoundException
String getActivityInstanceState(long activityInstanceId) throws ActivityInstanceNotFoundException
activityInstanceId
- Identifier of the activity instanceActivityInstanceNotFoundException
- if the activity cannot be foundboolean canExecuteTask(long activityInstanceId, long userId) throws ActivityInstanceNotFoundException, UserNotFoundException
activityInstanceId
- Identifier of the activity instanceuserId
- Identifier of a userInvalidSessionException
ActivityInstanceNotFoundException
- if the activity cannot be foundUserNotFoundException
- Error thrown if no user have an id corresponding to the value of userId parameterRetrieveException
- errors happen in while retrieving the instance of activityvoid releaseUserTask(long userTaskId) throws ActivityInstanceNotFoundException, UpdateException
userTaskId
- Identifier of user taskInvalidSessionException
- if the session is invalid, e.g. the session has expired.ActivityInstanceNotFoundException
- errors thrown if can't find corresponding activityUpdateException
List<ArchivedProcessInstance> getArchivedProcessInstances(long processInstanceId, int startIndex, int maxResults)
processInstanceId
- the process instance ID to retrieve the list of archives fromstartIndex
- the index of the page of results to getmaxResults
- the number of results to getInvalidSessionException
- if no current valid session is foundRetrieveException
- if search failed for a read reasonArchivedProcessInstance getFinalArchivedProcessInstance(long processInstanceId) throws ArchivedProcessInstanceNotFoundException
processInstanceId
- Identifier of the process instanceInvalidSessionException
- if no current valid session is foundRetrieveException
- if search failed for a read reasonArchivedProcessInstanceNotFoundException
void setActivityStateById(long activityInstanceId, int stateId) throws UpdateException
activityInstanceId
- Identifier of the activity instancestateId
- Identifier of stateInvalidSessionException
- if no current valid session is foundUpdateException
void setActivityStateByName(long activityInstanceId, String state) throws UpdateException
activityInstanceId
- Identifier of the activity instancestate
- representing new state of the activityInvalidSessionException
- if no current valid session is foundUpdateException
void setProcessInstanceState(ProcessInstance processInstance, String state) throws UpdateException
processInstance
- an instance of processstate
- representing new state of the activityInvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
void setTaskPriority(long userTaskInstanceId, TaskPriority priority) throws UpdateException
userTaskInstanceId
- Identifier of user task instancepriority
- new priority of this taskInvalidSessionException
- if the session is invalid, e.g. the session has expired.UpdateException
Map<String,Serializable> executeConnectorOnProcessDefinition(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, long processDefinitionId) 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 connectorprocessDefinitionId
- Identifier of the process definitionConnectorExecutionException
- TODOConnectorNotFoundException
- TODOInvalidSessionException
- if the session is invalid, e.g. the session has expired.Map<String,Serializable> executeConnectorOnProcessDefinition(String connectorDefinitionId, String connectorDefinitionVersion, Map<String,Expression> connectorInputParameters, Map<String,Map<String,Serializable>> inputValues, List<Operation> operations, Map<String,Serializable> operationInputValues, long processDefinitionId) 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)operationInputValues
- TODOprocessDefinitionId
- Identifier of the process definitionConnectorExecutionException
- TODOConnectorNotFoundException
- TODOInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchResult<ArchivedHumanTaskInstance> searchArchivedHumanTasks(SearchOptions searchOptions) throws SearchException
searchOptions
- search conditions and set sort,paging properties.InvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
SearchResult<HumanTaskInstance> searchAssignedTasksManagedBy(long managerUserId, SearchOptions searchOptions) throws SearchException
managerUserId
- Identifier of a usersearchOptions
- search conditions and set sort,paging properties.SearchException
- if there's wrong search condition, error happened.e.g,set a String value to long attribute.SearchResult<HumanTaskInstance> searchPendingTasksSupervisedBy(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of a usersearchOptions
- search conditions and set sort,paging properties.SearchException
- if there's wrong search condition, error happened.e.g,set a String value to long attribute.SearchResult<HumanTaskInstance> searchPendingTasksForUser(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of a usersearchOptions
- search conditions and set sort,paging properties.SearchException
- if there's wrong search condition, error happened.e.g,set a String value to long attribute.SearchResult<HumanTaskInstance> searchPendingTasksManagedBy(long managerUserId, SearchOptions searchOptions) throws SearchException
managerUserId
- same to user idsearchOptions
- search conditions and set sort,paging properties.InvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if there's wrong search condition, error happened.e.g,set a String value to long attribute.Map<Long,Long> getNumberOfOverdueOpenTasks(List<Long> userIds)
userIds
- a list of user identifiersInvalidSessionException
- if the session is invalid, e.g. the session has expired.void cancelProcessInstance(long processInstanceId) throws ProcessInstanceNotFoundException, UpdateException
processInstanceId
- Identifier of the process instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessInstanceNotFoundException
- if no process instance have an id corresponding to the value of processInstanceId parameter.RetrieveException
- Error happened when can't retrieve the instance of process.UpdateException
void retryTask(long activityInstanceId) throws ActivityInstanceNotFoundException, ActivityExecutionException
activityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ActivityInstanceNotFoundException
- errors thrown if can't find corresponding activityActivityExecutionException
- errors happened when one of the two step that re-set state of the task and execute it again failed.void hideTasks(long userId, Long... activityInstanceId) throws UpdateException
userId
- the ID of the user to hide the tasks for.activityInstanceId
- the ID of the task to hideInvalidSessionException
- in there is no current valid session.UpdateException
- in case a problem occurs when hiding one of the tasks.unhideTasks(long, Long...)
void unhideTasks(long userId, Long... activityInstanceId) throws UpdateException
userId
- the ID of the user to un-hide the tasks for.activityInstanceId
- the ID of the task to un-hideInvalidSessionException
- in there is no current valid session.UpdateException
- in case a problem occurs when un-hiding one of the tasks.hideTasks(long, Long...)
Serializable evaluateExpressionOnProcessDefinition(Expression expression, Map<String,Serializable> context, long processDefinitionId) throws ExpressionEvaluationException
expression
- the expression to evaluatecontext
- context values that is provided to evaluate the expressionprocessDefinitionId
- the id of the process of which the context will be used to evaluate the expressionInvalidSessionException
ExpressionEvaluationException
boolean isTaskHidden(long userTaskId, long userId)
userTaskId
- id of the task to checkuserId
- id of the userInvalidSessionException
RetrieveException
long countComments(SearchOptions searchOptions) throws SearchException
searchOptions
- Search conditions and set sort, paging propertiesSearchException
- if search could not be fullfilled correctlylong countAttachments(SearchOptions searchOptions) throws SearchException
searchOptions
- Search conditions and set sorts, paging propertiesSearchException
- if search could not be fullfilled correctlyvoid sendSignal(String signalName) throws SendEventException
signalName
- the signal nameInvalidSessionException
SendEventException
- if an Exception occurs while sending signalvoid sendMessage(String messageName, Expression targetProcess, Expression targetFlowNode, Map<Expression,Expression> messageContent) throws SendEventException
messageName
- the message nametargetProcess
- expression representing the target process nametargetFlowNode
- expression representing the target flow node namemessageContent
- a map representing the message data. The key is used for the data name and the value is used for the data valueInvalidSessionException
SendEventException
- if an Exception occurs while sending messagevoid sendMessage(String messageName, Expression targetProcess, Expression targetFlowNode, Map<Expression,Expression> messageContent, Map<Expression,Expression> correlations) throws SendEventException
messageName
- the message nametargetProcess
- expression representing the target process nametargetFlowNode
- expression representing the target flow node namemessageContent
- The message data. The key is used for the data name and the value is used for the data valuecorrelations
- the message correlations (five maximum).InvalidSessionException
SendEventException
- if there are too many correlations (more than 5) or an Exception occurs while sending messageArchivedProcessInstance getArchivedProcessInstance(long archivedProcessInstanceId) throws ArchivedProcessInstanceNotFoundException
ArchivedProcessInstance
from its id.archivedProcessInstanceId
- the ID of the ArchivedProcessInstance
to retrieve.ArchivedProcessInstance
instance.ArchivedProcessInstanceNotFoundException
- if the ArchivedProcessInstance
was not found.InvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- if a problem occurs while trying to retrieve the ArchivedFlowNodeInstance
.ArchivedFlowNodeInstance getArchivedFlowNodeInstance(long archivedFlowNodeInstanceId) throws ArchivedFlowNodeInstanceNotFoundException
ArchivedFlowNodeInstance
from its id.archivedFlowNodeInstanceId
- the ID of the ArchivedFlowNodeInstance
to retrieve.ArchivedFlowNodeInstance
instance.ArchivedFlowNodeInstanceNotFoundException
- if the ArchivedFlowNodeInstance
was not found.InvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- if a problem occurs while trying to retrieve the ArchivedFlowNodeInstance
.ArchivedComment getArchivedComment(long archivedCommentId) throws NotFoundException
ArchivedComment
from its id.archivedCommentId
- the ID of the ArchivedComment
to retrieve.ArchivedComment
instance.InvalidSessionException
- if the session is invalid, e.g. the session has expired.RetrieveException
- if a problem occurs while trying to retrieve the ArchivedComment
NotFoundException
- if not ArchivedComment
was found with id archivedCommentIdSearchResult<ConnectorInstance> searchConnectorInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- the search options parametersSearchResult
containing the ConnectorInstance
s matching the search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<ArchivedConnectorInstance> searchArchivedConnectorInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- the search options parametersSearchResult
containing the ArchivedConnectorInstance
s matching the search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlyList<HumanTaskInstance> getHumanTaskInstances(long processInstanceId, String taskName, int startIndex, int maxResults)
processInstanceId
- the ID of the process instance to look the HumanTaskInstance
s for.taskName
- the name of the tasks to searchstartIndex
- the result start indexmaxResults
- the max number of results to retrieveHumanTaskInstance
sInvalidSessionException
- if the session is invalid, e.g. the session has expired.HumanTaskInstance getLastStateHumanTaskInstance(long processInstanceId, String taskName) throws NotFoundException
processInstanceId
- the Identifier of the process instance for which to search the HumanTaskInstance
taskName
- the taskNotFoundException
- if no current task with provided name could be foundInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchResult<ArchivedActivityInstance> searchArchivedActivities(SearchOptions searchOptions) throws SearchException
searchOptions
- The criterion used to search for archived activity instancesSearchResult
containing the search resultInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if has exceptions during the process to search archived activity instanceSearchResult<ActivityInstance> searchActivities(SearchOptions searchOptions) throws SearchException
searchOptions
- The criterion used to activity instanceSearchResult
containing the search resultInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<FlowNodeInstance> searchFlowNodeInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- the search options parametersSearchResult
containing the search resultInvalidSessionException
- If API Session is invalid, e.g session has expired.SearchException
- if an exception occurs while performing the searchSearchResult<ArchivedFlowNodeInstance> searchArchivedFlowNodeInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- the search options parametersSearchResult
containing the found archived flown node instances.InvalidSessionException
- If API Session is invalid, e.g session has expired.SearchException
- if an exception occurs while performing the searchArchivedFlowNodeInstance}
SearchResult<HumanTaskInstance> searchMyAvailableHumanTasks(long userId, SearchOptions searchOptions) throws SearchException
userId
- the user for whom to retrieve the taskssearchOptions
- the search options parametersInvalidSessionException
- if the current session is invalidSearchException
- in case a search problem occursSearchResult<Comment> searchComments(SearchOptions searchOptions) throws SearchException
searchOptions
- The options used to search for CommentsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- in case a search problem occursComment addComment(long processInstanceId, String comment)
processInstanceId
- Identifier of the processInstancecomment
- The content of commentInvalidSessionException
- if the session is invalid, e.g. the session has expired.List<Comment> getComments(long processInstanceId)
processInstanceId
- Identifier of the processInstanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchResult<Comment> searchCommentsManagedBy(long managerUserId, SearchOptions searchOptions) throws SearchException
managerUserId
- Identifier of the usersearchOptions
- The criterion used to search CommentInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<Comment> searchCommentsInvolvingUser(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of the usersearchOptions
- The criterion used to search CommentInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlyList<Long> getChildrenInstanceIdsOfProcessInstance(long processInstanceId, int startIndex, int maxResults, ProcessInstanceCriterion criterion)
processInstanceId
- Identifier of the processDefinitionstartIndex
- Index of the page to be returned. First page has index 0.maxResults
- Number of result per page. Maximum number of result returned.criterion
- The criterion used to sort the resultInvalidSessionException
- if the session is invalid, e.g. the session has expired.boolean isInvolvedInProcessInstance(long userId, long processInstanceId) throws ProcessInstanceNotFoundException, UserNotFoundException
userId
- Identifier of the userprocessInstanceId
- Identifier of the processDefinitionInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessInstanceNotFoundException
- if no processInstance have an id corresponding to the parameter.UserNotFoundException
- if no user have an id corresponding to the parameter.long getProcessInstanceIdFromActivityInstanceId(long activityInstanceId) throws ProcessInstanceNotFoundException
activityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessInstanceNotFoundException
- if no processInstance have an id corresponding to the parameter.long getProcessDefinitionIdFromProcessInstanceId(long processInstanceId) throws ProcessDefinitionNotFoundException
processInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessDefinitionNotFoundException
- if no ProcessDefinition have an id corresponding to the parameter.long getProcessDefinitionIdFromActivityInstanceId(long activityInstanceId) throws ProcessDefinitionNotFoundException
activityInstanceId
- Identifier of the activity instanceInvalidSessionException
- if the session is invalid, e.g. the session has expired.ProcessDefinitionNotFoundException
- if no ProcessDefinition have an id corresponding to the parameter.SearchResult<ArchivedComment> searchArchivedComments(SearchOptions searchOptions) throws SearchException
searchOptions
- The ArchivedComment search optionsArchivedComment
matching the search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<ArchivedHumanTaskInstance> searchArchivedHumanTasksManagedBy(long managerUserId, SearchOptions searchOptions) throws SearchException
managerUserId
- Identifier of the user managersearchOptions
- The ArchivedHumanTaskInstance search optionsSearchException
- if search could not be fullfilled correctlySearchResult<ProcessInstance> searchOpenProcessInstancesInvolvingUser(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of the usersearchOptions
- The criterion used to search ProcessInstanceProcessInstance
s matching the search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<ProcessInstance> searchOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId, SearchOptions searchOptions) throws SearchException
managerUserId
- the ID of the user managersearchOptions
- the ProcessInstance search options (pagination, filter, order sort)ProcessInstance
s matching the search optionsSearchException
- if search could not be fullfilled correctlyInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchResult<ArchivedProcessInstance> searchArchivedProcessInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- the ArchivedProcessInstance search options (pagination, filter, order sort)SearchException
- if search could not be fullfilled correctlyInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchResult<ArchivedProcessInstance> searchArchivedProcessInstancesSupervisedBy(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of the usersearchOptions
- the ArchivedProcessInstance search options (pagination, filter, order sort)InvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<ArchivedProcessInstance> searchArchivedProcessInstancesInvolvingUser(long userId, SearchOptions searchOptions) throws SearchException
userId
- Identifier of the usersearchOptions
- the ArchivedProcessInstance search options (pagination, filter, order sort)InvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<HumanTaskInstance> searchHumanTaskInstances(SearchOptions searchOptions) throws SearchException
searchOptions
- the HumanTaskInstance search options (pagination, filter, order sort)HumanTaskInstance
s matching the provided search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<HumanTaskInstance> searchAssignedTasksSupervisedBy(long supervisorId, SearchOptions searchOptions) throws SearchException
supervisorId
- the id of the process Supervisor usersearchOptions
- the HumanTaskInstance search options (pagination, filter, order sort)HumanTaskInstance
s matching the provided search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlySearchResult<ArchivedHumanTaskInstance> searchArchivedHumanTasksSupervisedBy(long supervisorId, SearchOptions searchOptions) throws SearchException
supervisorId
- the id of the process Supervisor usersearchOptions
- the ArchivedHumanTaskInstance search options (pagination, filter, order sort)ArchivedHumanTaskInstance
s matching the provided search optionsInvalidSessionException
- if the session is invalid, e.g. the session has expired.SearchException
- if search could not be fullfilled correctlyMap<String,Serializable> evaluateExpressionsAtProcessInstanciation(long processInstanceId, Map<Expression,Map<String,Serializable>> expressions) throws ExpressionEvaluationException
processInstanceId
- The identifier of process instanceexpressions
- Map of expressions to evaluateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ExpressionEvaluationException
- occurs when an exception is thrown during expression evaluationMap<String,Serializable> evaluateExpressionOnCompletedProcessInstance(long processInstanceId, Map<Expression,Map<String,Serializable>> expressions) throws ExpressionEvaluationException
processInstanceId
- The identifier of process instanceexpressions
- Map of expressions to evaluateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ExpressionEvaluationException
- occurs when an exception is thrown during expression evaluationMap<String,Serializable> evaluateExpressionsOnProcessInstance(long processInstanceId, Map<Expression,Map<String,Serializable>> expressions) throws ExpressionEvaluationException
processInstanceId
- The identifier of process instanceexpressions
- Map of expressions to evaluateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ExpressionEvaluationException
- occurs when an exception is thrown during expression evaluationMap<String,Serializable> evaluateExpressionsOnProcessDefinition(long processDefinitionId, Map<Expression,Map<String,Serializable>> expressions) throws ExpressionEvaluationException
processDefinitionId
- The identifier of process definitionexpressions
- Map of expressions to evaluateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ExpressionEvaluationException
- occurs when an exception is thrown during expression evaluationMap<String,Serializable> evaluateExpressionsOnActivityInstance(long activityInstanceId, Map<Expression,Map<String,Serializable>> expressions) throws ExpressionEvaluationException
activityInstanceId
- The identifier of activity instanceexpressions
- Map of expressions to evaluateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ExpressionEvaluationException
- occurs when an exception is thrown during expression evaluationMap<String,Serializable> evaluateExpressionsOnCompletedActivityInstance(long activityInstanceId, Map<Expression,Map<String,Serializable>> expressions) throws ExpressionEvaluationException
activityInstanceId
- The identifier of activity instanceexpressions
- Map of expressions to evaluateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.ExpressionEvaluationException
- occurs when an exception is thrown during expression evaluationCopyright © 2013 BonitaSoft. All Rights Reserved.