|
||||||||||
上一个类 下一个类 | 框架 无框架 | |||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
public interface RuntimeService
方法摘要 | |
---|---|
void |
activateProcessInstanceById(String processInstanceId)
Activates the process instance with the given id. |
void |
addUserIdentityLink(String processInstanceId,
String userId,
String identityLinkType)
Involves a user with a process instance. |
ExecutionQuery |
createExecutionQuery()
Creates a new ExecutionQuery instance,
that can be used to query the executions and process instances. |
NativeExecutionQuery |
createNativeExecutionQuery()
creates a new NativeExecutionQuery to query Execution s
by SQL directly |
NativeProcessInstanceQuery |
createNativeProcessInstanceQuery()
creates a new NativeProcessInstanceQuery to query ProcessInstance s
by SQL directly |
ProcessInstanceQuery |
createProcessInstanceQuery()
Creates a new ProcessInstanceQuery instance, that can be used
to query process instances. |
void |
deleteProcessInstance(String processInstanceId,
String deleteReason)
Delete an existing runtime process instance. |
List<String> |
getActiveActivityIds(String executionId)
Finds the activity ids for all executions that are waiting in activities. |
List<IdentityLink> |
getIdentityLinksForProcessInstance(String instanceId)
Retrieves the IdentityLink s associated with the given process instance. |
Object |
getVariable(String executionId,
String variableName)
The variable value. |
Object |
getVariableLocal(String executionId,
String variableName)
The variable value for an execution. |
Map<String,Object> |
getVariables(String executionId)
All variables visible from the given execution scope (including parent scopes). |
Map<String,Object> |
getVariables(String executionId,
Collection<String> variableNames)
The variable values for all given variableNames, takes all variables into account which are visible from the given execution scope (including parent scopes). |
Map<String,Object> |
getVariablesLocal(String executionId)
All variable values that are defined in the execution scope, without taking outer scopes into account. |
Map<String,Object> |
getVariablesLocal(String executionId,
Collection<String> variableNames)
The variable values for the given variableNames only taking the given execution scope into account, not looking in outer scopes. |
boolean |
hasVariable(String executionId,
String variableName)
Check whether or not this execution has variable set with the given name, Searching for the variable is done in all scopes that are visible to the given execution (including parent scopes). |
boolean |
hasVariableLocal(String executionId,
String variableName)
Check whether or not this execution has a local variable set with the given name. |
void |
messageEventReceived(String messageName,
String executionId)
Notifies the process engine that a message event with name 'messageName' has been received and has been correlated to an execution with id 'executionId'. |
void |
messageEventReceived(String messageName,
String executionId,
Map<String,Object> processVariables)
Notifies the process engine that a message event with the name 'messageName' has been received and has been correlated to an execution with id 'executionId'. |
void |
messageEventReceivedAsync(String messageName,
String executionId)
Notifies the process engine that a message event with the name 'messageName' has been received and has been correlated to an execution with id 'executionId'. |
void |
removeVariable(String executionId,
String variableName)
Removes a variable for an execution. |
void |
removeVariableLocal(String executionId,
String variableName)
Removes a variable for an execution (not considering parent scopes). |
void |
removeVariables(String executionId,
Collection<String> variableNames)
Removes variables for an execution. |
void |
removeVariablesLocal(String executionId,
Collection<String> variableNames)
Remove variables for an execution (not considering parent scopes). |
void |
setVariable(String executionId,
String variableName,
Object value)
Update or create a variable for an execution. |
void |
setVariableLocal(String executionId,
String variableName,
Object value)
Update or create a variable for an execution (not considering parent scopes). |
void |
setVariables(String executionId,
Map<String,? extends Object> variables)
Update or create given variables for an execution (including parent scopes). |
void |
setVariablesLocal(String executionId,
Map<String,? extends Object> variables)
Update or create given variables for an execution (not considering parent scopes). |
void |
signal(String executionId)
Sends an external trigger to an activity instance that is waiting inside the given execution. |
void |
signal(String executionId,
Map<String,Object> processVariables)
Sends an external trigger to an activity instance that is waiting inside the given execution. |
void |
signalEventReceived(String signalName)
Notifies the process engine that a signal event of name 'signalName' has been received. |
void |
signalEventReceived(String signalName,
Map<String,Object> processVariables)
Notifies the process engine that a signal event of name 'signalName' has been received. |
void |
signalEventReceived(String signalName,
String executionId)
Notifies the process engine that a signal event of name 'signalName' has been received. |
void |
signalEventReceived(String signalName,
String executionId,
Map<String,Object> processVariables)
Notifies the process engine that a signal event of name 'signalName' has been received. |
void |
signalEventReceivedAsync(String signalName)
Notifies the process engine that a signal event of name 'signalName' has been received. |
void |
signalEventReceivedAsync(String signalName,
String executionId)
Notifies the process engine that a signal event of name 'signalName' has been received. |
ProcessInstance |
startProcessInstanceById(String processDefinitionId)
Starts a new process instance in the exactly specified version of the process definition with the given id. |
ProcessInstance |
startProcessInstanceById(String processDefinitionId,
Map<String,Object> variables)
Starts a new process instance in the exactly specified version of the process definition with the given id. |
ProcessInstance |
startProcessInstanceById(String processDefinitionId,
String businessKey)
Starts a new process instance in the exactly specified version of the process definition with the given id. |
ProcessInstance |
startProcessInstanceById(String processDefinitionId,
String businessKey,
Map<String,Object> variables)
Starts a new process instance in the exactly specified version of the process definition with the given id. |
ProcessInstance |
startProcessInstanceByKey(String processDefinitionKey)
Starts a new process instance in the latest version of the process definition with the given key. |
ProcessInstance |
startProcessInstanceByKey(String processDefinitionKey,
Map<String,Object> variables)
Starts a new process instance in the latest version of the process definition with the given key |
ProcessInstance |
startProcessInstanceByKey(String processDefinitionKey,
String businessKey)
Starts a new process instance in the latest version of the process definition with the given key. |
ProcessInstance |
startProcessInstanceByKey(String processDefinitionKey,
String businessKey,
Map<String,Object> variables)
Starts a new process instance in the latest version of the process definition with the given key. |
ProcessInstance |
startProcessInstanceByMessage(String messageName)
Signals the process engine that a message is received and starts a new ProcessInstance . |
ProcessInstance |
startProcessInstanceByMessage(String messageName,
Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new ProcessInstance . |
ProcessInstance |
startProcessInstanceByMessage(String messageName,
String businessKey)
Signals the process engine that a message is received and starts a new ProcessInstance . |
ProcessInstance |
startProcessInstanceByMessage(String messageName,
String businessKey,
Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new ProcessInstance . |
void |
suspendProcessInstanceById(String processInstanceId)
Suspends the process instance with the given id. |
void |
updateBusinessKey(String processInstanceId,
String businessKey)
Updates the business key for the provided process instance |
方法详细信息 |
---|
ProcessInstance startProcessInstanceByKey(String processDefinitionKey)
processDefinitionKey
- key of process definition, cannot be null.
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceByKey(String processDefinitionKey, String businessKey)
ProcessInstanceQuery.processInstanceBusinessKey(String)
. Providing such a business
key is definitely a best practice.
Note that a business key MUST be unique for the given process definition.
Process instance from different process definition are allowed to have the
same business key.
The combination of processdefinitionKey-businessKey must be unique.
processDefinitionKey
- key of process definition, cannot be null.businessKey
- a key that uniquely identifies the process instance in the context
or the given process definition.
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceByKey(String processDefinitionKey, Map<String,Object> variables)
processDefinitionKey
- key of process definition, cannot be null.variables
- the variables to pass, can be null.
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceByKey(String processDefinitionKey, String businessKey, Map<String,Object> variables)
ProcessInstanceQuery.processInstanceBusinessKey(String)
. Providing such a business
key is definitely a best practice.
Note that a business key MUST be unique for the given process definition.
Process instance from different process definition are allowed to have the
same business key.
The combination of processdefinitionKey-businessKey must be unique.
processDefinitionKey
- key of process definition, cannot be null.variables
- the variables to pass, can be null.businessKey
- a key that uniquely identifies the process instance in the context or the
given process definition.
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceById(String processDefinitionId)
processDefinitionId
- the id of the process definition, cannot be null.
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceById(String processDefinitionId, String businessKey)
ProcessInstanceQuery.processInstanceBusinessKey(String)
. Providing such a business
key is definitely a best practice.
Note that a business key MUST be unique for the given process definition.
Process instance from different process definition are allowed to have the
same business key.
processDefinitionId
- the id of the process definition, cannot be null.businessKey
- a key that uniquely identifies the process instance in the context or the
given process definition.
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceById(String processDefinitionId, Map<String,Object> variables)
processDefinitionId
- the id of the process definition, cannot be null.variables
- variables to be passed, can be null
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceById(String processDefinitionId, String businessKey, Map<String,Object> variables)
ProcessInstanceQuery.processInstanceBusinessKey(String)
. Providing such a business
key is definitely a best practice.
Note that a business key MUST be unique for the given process definition.
Process instance from different process definition are allowed to have the
same business key.
processDefinitionId
- the id of the process definition, cannot be null.variables
- variables to be passed, can be null
ActivitiObjectNotFoundException
- when no process definition is deployed with the given key.ProcessInstance startProcessInstanceByMessage(String messageName)
Signals the process engine that a message is received and starts a new
ProcessInstance
.
Calling this method can have two different outcomes:
ActivitiException
is thrown
messageName
- the 'name' of the message as specified as an attribute on the
bpmn20 <message name="messageName" />
element.
ProcessInstance
object representing the started process instance
ActivitiExeception
- if no subscription to a message with the given name existsProcessInstance startProcessInstanceByMessage(String messageName, String businessKey)
Signals the process engine that a message is received and starts a new
ProcessInstance
.
startProcessInstanceByMessage(String, Map)
. This method allows
specifying a business key.
messageName
- the 'name' of the message as specified as an attribute on the
bpmn20 <message name="messageName" />
element.businessKey
- the business key which is added to the started process instance
ActivitiExeception
- if no subscription to a message with the given name existsProcessInstance startProcessInstanceByMessage(String messageName, Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new
ProcessInstance
.
startProcessInstanceByMessage(String)
. In addition, this method allows
specifying a the payload of the message as a map of process variables.
messageName
- the 'name' of the message as specified as an attribute on the
bpmn20 <message name="messageName" />
element.processVariables
- the 'payload' of the message. The variables are added as processes
variables to the started process instance.
ProcessInstance
object representing the started process instance
ActivitiExeception
- if no subscription to a message with the given name existsProcessInstance startProcessInstanceByMessage(String messageName, String businessKey, Map<String,Object> processVariables)
Signals the process engine that a message is received and starts a new
ProcessInstance
.
startProcessInstanceByMessage(String, Map)
. In addition, this method allows
specifying a business key.
messageName
- the 'name' of the message as specified as an attribute on the
bpmn20 <message name="messageName" />
element.businessKey
- the business key which is added to the started process instanceprocessVariables
- the 'payload' of the message. The variables are added as processes
variables to the started process instance.
ProcessInstance
object representing the started process instance
ActivitiExeception
- if no subscription to a message with the given name existsvoid deleteProcessInstance(String processInstanceId, String deleteReason)
processInstanceId
- id of process instance to delete, cannot be null.deleteReason
- reason for deleting, can be null.
ActivitiObjectNotFoundException
- when no process instance is found with the given id.List<String> getActiveActivityIds(String executionId)
executionId
- id of the execution, cannot be null.
ActivitiObjectNotFoundException
- when no execution exists with the given executionId.void signal(String executionId)
executionId
- id of execution to signal, cannot be null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.void signal(String executionId, Map<String,Object> processVariables)
executionId
- id of execution to signal, cannot be null.processVariables
- a map of process variables
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.void updateBusinessKey(String processInstanceId, String businessKey)
processInstanceId
- id of the process instance to set the business key, cannot be nullbusinessKey
- new businessKey valuevoid addUserIdentityLink(String processInstanceId, String userId, String identityLinkType)
processInstanceId
- id of the process instance, cannot be null.userId
- id of the user involve, cannot be null.identityLinkType
- type of identityLink, cannot be null (@see IdentityLinkType
).
ActivitiObjectNotFoundException
- when the process instance doesn't exist.List<IdentityLink> getIdentityLinksForProcessInstance(String instanceId)
IdentityLink
s associated with the given process instance.
Such an IdentityLink
informs how a certain user is involved with a process instance.
Map<String,Object> getVariables(String executionId)
executionId
- id of execution, cannot be null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.Map<String,Object> getVariablesLocal(String executionId)
getVariablesLocal(String, Collection)
for better performance.
executionId
- id of execution, cannot be null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.Map<String,Object> getVariables(String executionId, Collection<String> variableNames)
executionId
- id of execution, cannot be null.variableNames
- the collection of variable names that should be retrieved.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.Map<String,Object> getVariablesLocal(String executionId, Collection<String> variableNames)
executionId
- id of execution, cannot be null.variableNames
- the collection of variable names that should be retrieved.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.Object getVariable(String executionId, String variableName)
executionId
- id of execution, cannot be null.variableName
- name of variable, cannot be null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.boolean hasVariable(String executionId, String variableName)
Object getVariableLocal(String executionId, String variableName)
boolean hasVariableLocal(String executionId, String variableName)
void setVariable(String executionId, String variableName, Object value)
executionId
- id of execution to set variable in, cannot be null.variableName
- name of variable to set, cannot be null.value
- value to set. When null is passed, the variable is not removed,
only it's value will be set to null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.void setVariableLocal(String executionId, String variableName, Object value)
executionId
- id of execution to set variable in, cannot be null.variableName
- name of variable to set, cannot be null.value
- value to set. When null is passed, the variable is not removed,
only it's value will be set to null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.void setVariables(String executionId, Map<String,? extends Object> variables)
executionId
- id of the execution, cannot be null.variables
- map containing name (key) and value of variables, can be null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.void setVariablesLocal(String executionId, Map<String,? extends Object> variables)
executionId
- id of the execution, cannot be null.variables
- map containing name (key) and value of variables, can be null.
ActivitiObjectNotFoundException
- when no execution is found for the given executionId.void removeVariable(String executionId, String variableName)
executionId
- id of execution to remove variable in.variableName
- name of variable to remove.void removeVariableLocal(String executionId, String variableName)
executionId
- id of execution to remove variable in.variableName
- name of variable to remove.void removeVariables(String executionId, Collection<String> variableNames)
executionId
- id of execution to remove variable in.variableNames
- collection containing name of variables to remove.void removeVariablesLocal(String executionId, Collection<String> variableNames)
executionId
- id of execution to remove variable in.variableNames
- collection containing name of variables to remove.ExecutionQuery createExecutionQuery()
ExecutionQuery
instance,
that can be used to query the executions and process instances.
NativeExecutionQuery createNativeExecutionQuery()
NativeExecutionQuery
to query Execution
s
by SQL directly
ProcessInstanceQuery createProcessInstanceQuery()
ProcessInstanceQuery
instance, that can be used
to query process instances.
NativeProcessInstanceQuery createNativeProcessInstanceQuery()
NativeProcessInstanceQuery
to query ProcessInstance
s
by SQL directly
void suspendProcessInstanceById(String processInstanceId)
ActivitiObjectNotFoundException
- if no such processInstance can be found.
ActivitiException
- the process instance is already in state suspended.void activateProcessInstanceById(String processInstanceId)
ActivitiObjectNotFoundException
- if no such processInstance can be found.
ActivitiException
- if the process instance is already in state active.void signalEventReceived(String signalName)
signalName
- the name of the signal eventvoid signalEventReceivedAsync(String signalName)
signalName
- the name of the signal eventvoid signalEventReceived(String signalName, Map<String,Object> processVariables)
signalName
- the name of the signal eventprocessVariables
- a map of variables added to the execution(s)void signalEventReceived(String signalName, String executionId)
signalName
- the name of the signal eventexecutionId
- the id of the execution to deliver the signal to
ActivitiObjectNotFoundException
- if no such execution exists.
ActivitiException
- if the execution has not subscribed to the signal.void signalEventReceived(String signalName, String executionId, Map<String,Object> processVariables)
signalName
- the name of the signal eventexecutionId
- the id of the execution to deliver the signal toprocessVariables
- a map of variables added to the execution(s)
ActivitiObjectNotFoundException
- if no such execution exists.
ActivitiException
- if the execution has not subscribed to the signalvoid signalEventReceivedAsync(String signalName, String executionId)
signalName
- the name of the signal eventexecutionId
- the id of the execution to deliver the signal to
ActivitiObjectNotFoundException
- if no such execution exists.
ActivitiException
- if the execution has not subscribed to the signal.void messageEventReceived(String messageName, String executionId)
messageName
- the name of the message eventexecutionId
- the id of the execution to deliver the message to
ActivitiObjectNotFoundException
- if no such execution exists.
ActivitiException
- if the execution has not subscribed to the signalvoid messageEventReceived(String messageName, String executionId, Map<String,Object> processVariables)
messageName
- the name of the message eventexecutionId
- the id of the execution to deliver the message toprocessVariables
- a map of variables added to the execution
ActivitiObjectNotFoundException
- if no such execution exists.
ActivitiException
- if the execution has not subscribed to the signalvoid messageEventReceivedAsync(String messageName, String executionId)
messageName
- the name of the message eventexecutionId
- the id of the execution to deliver the message to
ActivitiObjectNotFoundException
- if no such execution exists.
ActivitiException
- if the execution has not subscribed to the signal
|
||||||||||
上一个类 下一个类 | 框架 无框架 | |||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |