Uses of Interface
org.bonitasoft.engine.bpm.process.ProcessInstance

Packages that use ProcessInstance

Package	Description
com.bonitasoft.engine.api	The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
org.bonitasoft.engine.api	The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.

Uses of ProcessInstance in com.bonitasoft.engine.api

Methods in com.bonitasoft.engine.api that return ProcessInstance

Modifier and Type	Method and Description
ProcessInstance	ProcessRuntimeAPI.updateProcessInstance(long processInstanceId, ProcessInstanceUpdater updater) Update an instance of process with the given processInstanceId.
ProcessInstance	ProcessRuntimeAPI.updateProcessInstanceIndex(long processInstanceId, Index index, String value) Update an index of a process instance.

Uses of ProcessInstance in org.bonitasoft.engine.api

Methods in org.bonitasoft.engine.api that return ProcessInstance

Modifier and Type	Method and Description
ProcessInstance	ProcessRuntimeAPI.getProcessInstance(long processInstanceId) Get the specified process instance.
ProcessInstance	ProcessRuntimeAPI.startProcess(long processDefinitionId) Start an instance of the process with the specified process definition, using the current session user.
ProcessInstance	ProcessRuntimeAPI.startProcess(long processDefinitionId, List<Operation> operations, Map<String,Serializable> context) Start an instance of the process with the specified process definition id, and set the initial values of the data with the given operations.
ProcessInstance	ProcessRuntimeAPI.startProcess(long userId, long processDefinitionId) Start an instance of the process with the specified process definition id on behalf of a given user.
ProcessInstance	ProcessRuntimeAPI.startProcess(long userId, long processDefinitionId, List<Operation> operations, Map<String,Serializable> context) Start an instance of the process with the specified process definition id on behalf of a given user, and set the initial values of the data with the given operations.
ProcessInstance	ProcessRuntimeAPI.startProcess(long userId, long processDefinitionId, Map<String,Serializable> initialVariables) Start an instance of the process with the specified process definition id on behalf of a given user, and set the initial values of the data with the given initialVariables.
ProcessInstance	ProcessRuntimeAPI.startProcess(long processDefinitionId, Map<String,Serializable> initialVariables) Instantiates a process.
ProcessInstance	ProcessRuntimeAPI.startProcessWithInputs(long userId, long processDefinitionId, Map<String,Serializable> instantiationInputs) Start an instance of the process with the specified process definition id on behalf of a given user, and provides inputs to fulfill Process Contract.
ProcessInstance	ProcessRuntimeAPI.startProcessWithInputs(long processDefinitionId, Map<String,Serializable> instantiationInputs) Start an instance of the process with the specified process definition id, and provides inputs to fulfill Process Contract.

Methods in org.bonitasoft.engine.api that return types with arguments of type ProcessInstance

Modifier and Type	Method and Description
List<ProcessInstance>	ProcessRuntimeAPI.getProcessInstances(int startIndex, int maxResults, ProcessInstanceCriterion criterion) Get a paged list of all process instances.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchFailedProcessInstances(SearchOptions searchOptions) List all process instances with at least one failed task or the ProcessInstanceState.ERROR state.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchFailedProcessInstancesSupervisedBy(long userId, SearchOptions searchOptions) List all process instances with at least one failed task or the ProcessInstanceState.ERROR state that are supervised by the given user.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstances(SearchOptions searchOptions) List all open root process instances.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstancesInvolvingUser(long userId, SearchOptions searchOptions) Search for open process instances that the specified user can access.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstancesInvolvingUsersManagedBy(long managerUserId, SearchOptions searchOptions) Search for open process instances that all subordinates of the specified user can access.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchOpenProcessInstancesSupervisedBy(long userId, SearchOptions searchOptions) List all open process instances supervised by a user.
SearchResult<ProcessInstance>	ProcessRuntimeAPI.searchProcessInstances(SearchOptions searchOptions) List all process instances.

Methods in org.bonitasoft.engine.api with parameters of type ProcessInstance

Modifier and Type	Method and Description
void	ProcessRuntimeAPI.setProcessInstanceState(ProcessInstance processInstance, String state) Set a state of a process instance.