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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Document |
DocumentAPI.addDocument(long processInstanceId,
String documentName,
String description,
DocumentValue documentValue)
Attach a new document to a process instance.
|
Document |
DocumentAPI.attachDocument(long processInstanceId,
String documentName,
String fileName,
String mimeType,
byte[] documentContent)
Attach the given document to the specified process instance.
|
Document |
DocumentAPI.attachDocument(long processInstanceId,
String documentName,
String fileName,
String mimeType,
String url)
Attach a document by reference to the specified process instance.
|
void |
ProcessRuntimeAPI.cancelProcessInstance(long processInstanceId)
Cancels the process instance and all of its active flow nodes.
|
Map<String,Serializable> |
ProcessRuntimeAPI.getArchivedProcessInstanceExecutionContext(long archivedProcessInstanceId)
return the context defined in the process definition for this process instance.
|
List<Document> |
DocumentAPI.getLastVersionOfDocuments(long processInstanceId,
int pageIndex,
int numberPerPage,
DocumentCriterion pagingCriterion)
Get the latest version of all documents attached to the specified process instance.
|
int |
ProcessRuntimeAPI.getNumberOfOpenedActivityInstances(long processInstanceId)
Get the total number of open activity instances by process instance id.
|
long |
ProcessRuntimeAPI.getNumberOfProcessDataInstances(long processInstanceId)
Get the number of process data instances by process id.
|
long |
ProcessRuntimeAPI.getOneAssignedUserTaskInstanceOfProcessInstance(long processInstanceId,
long userId)
Get an instance of a task asssigned to a given user for the specified process instance.
|
ProcessInstance |
ProcessRuntimeAPI.getProcessInstance(long processInstanceId)
Get the specified process instance.
|
Map<String,Serializable> |
ProcessRuntimeAPI.getProcessInstanceExecutionContext(long processInstanceId)
return the context defined in the process definition for this process instance.
|
long |
ProcessRuntimeAPI.getProcessInstanceIdFromActivityInstanceId(long activityInstanceId)
Get the process instance id from an activity instance id.
|
boolean |
ProcessRuntimeAPI.isInvolvedInProcessInstance(long userId,
long processInstanceId)
Check whether a specific user is involved in a given process instance.
User A is involved with a process instance if any of the following is true: user A has started the process instance a task in the process instance is assigned to user A a task in the process instance is pending for user A a task in the process instance has been performed by user A This method also applies to completed instances of process. |
boolean |
ProcessRuntimeAPI.isManagerOfUserInvolvedInProcessInstance(long managerUserId,
long processInstanceId)
Check whether a specific user has at least one subordinate (person he / she is the manager of) involved in a given process instance.
User A is involved with a process instance if any of the following is true: user A has started the process instance a task in the process instance is assigned to user A a task in the process instance is pending for user A a task in the process instance has been performed by user A This method also applies to completed instances of process. |
Document |
DocumentAPI.updateDocument(long documentId,
DocumentValue documentValue)
Attach a new document version to a process instance.
|
Copyright © 2017 Bonitasoft S.A.. All rights reserved.