public interface ProcessInstanceAdminService
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeError(String... errorId)
Acknowledge given error that it was reviewed and understood
|
void |
cancelNodeInstance(long processInstanceId,
long nodeInstanceId)
Cancels node instance with given id within given process instance.
|
Collection<NodeInstanceDesc> |
getActiveNodeInstances(long processInstanceId)
Returns all active node instances in given process instance;
|
org.kie.internal.runtime.error.ExecutionError |
getError(String errorId)
Returns execution error identified by given error id
|
List<org.kie.internal.runtime.error.ExecutionError> |
getErrors(boolean includeAcknowledged,
org.kie.api.runtime.query.QueryContext queryContext)
Returns all execution errors regardless of their type
|
List<org.kie.internal.runtime.error.ExecutionError> |
getErrorsByProcessId(String deploymentId,
String processId,
boolean includeAcknowledged,
org.kie.api.runtime.query.QueryContext queryContext)
Returns execution errors for given process id and deployment id
|
List<org.kie.internal.runtime.error.ExecutionError> |
getErrorsByProcessInstanceId(long processInstanceId,
boolean includeAcknowledged,
org.kie.api.runtime.query.QueryContext queryContext)
Returns execution errors for given process instance id
|
List<org.kie.internal.runtime.error.ExecutionError> |
getErrorsByProcessInstanceId(long processInstanceId,
String nodeName,
boolean includeAcknowledged,
org.kie.api.runtime.query.QueryContext queryContext)
Returns execution errors for given process instance id and node
|
Collection<ProcessNode> |
getProcessNodes(long processInstanceId)
Returns all process nodes found in given process instance.
|
Collection<TimerInstance> |
getTimerInstances(long processInstanceId)
Returns active timers for given process instance.
|
void |
retriggerNodeInstance(long processInstanceId,
long nodeInstanceId)
Retriggers (which includes cancel) node instance given with node instance id within process instance.
|
void |
triggerNode(long processInstanceId,
long nodeId)
Triggers node to create new node instance with node id within process instance.
|
void |
updateTimer(long processInstanceId,
long timerId,
long delay,
long period,
int repeatLimit)
Updates active timer identified by timer id with delay that is given in seconds.
|
void |
updateTimerRelative(long processInstanceId,
long timerId,
long delay,
long period,
int repeatLimit)
Updates active timer identified by timer id with delay that is given in seconds and is relative to current time.
|
Collection<ProcessNode> getProcessNodes(long processInstanceId) throws ProcessInstanceNotFoundException
processInstanceId
- unique id of process instanceProcessInstanceNotFoundException
- in case process instance id with given id was not foundvoid cancelNodeInstance(long processInstanceId, long nodeInstanceId) throws NodeInstanceNotFoundException, ProcessInstanceNotFoundException
processInstanceId
- unique id of process instancenodeInstanceId
- node instance id within given process instance to be canceledNodeInstanceNotFoundException
- in case node instance with given id is not activeProcessInstanceNotFoundException
- in case process instance id with given id was not foundvoid retriggerNodeInstance(long processInstanceId, long nodeInstanceId) throws NodeInstanceNotFoundException, ProcessInstanceNotFoundException
processInstanceId
- unique id of process instancenodeInstanceId
- node instance id within given process instance to be retriggeredNodeInstanceNotFoundException
- in case node instance with given id is not activeProcessInstanceNotFoundException
- in case process instance id with given id was not foundCollection<NodeInstanceDesc> getActiveNodeInstances(long processInstanceId) throws ProcessInstanceNotFoundException
processInstanceId
- unique id of process instanceProcessInstanceNotFoundException
- in case process instance id with given id was not foundvoid updateTimer(long processInstanceId, long timerId, long delay, long period, int repeatLimit) throws NodeInstanceNotFoundException, ProcessInstanceNotFoundException
processInstanceId
- unique id of process instancetimerId
- timer id that should be updateddelay
- absolute delay in secondsperiod
- in case of repeatable timer how often it should repeat in milliseconds - if not applicable should be set to -1repeatLimit
- in case of repeatable timer how many times it should trigger - if not applicable should be set to -1NodeInstanceNotFoundException
- in case node instance with given id is not activeProcessInstanceNotFoundException
- in case process instance id with given id was not foundvoid updateTimerRelative(long processInstanceId, long timerId, long delay, long period, int repeatLimit) throws NodeInstanceNotFoundException, ProcessInstanceNotFoundException
processInstanceId
- unique id of process instancetimerId
- timer id that should be updateddelay
- absolute delay in secondsperiod
- in case of repeatable timer how often it should repeat in milliseconds - if not applicable should be set to -1repeatLimit
- in case of repeatable timer how many times it should trigger - if not applicable should be set to -1NodeInstanceNotFoundException
- in case node instance with given id is not activeProcessInstanceNotFoundException
- in case process instance id with given id was not foundCollection<TimerInstance> getTimerInstances(long processInstanceId) throws ProcessInstanceNotFoundException
processInstanceId
- unique id of process instanceProcessInstanceNotFoundException
- in case process instance id with given id was not foundvoid triggerNode(long processInstanceId, long nodeId) throws NodeNotFoundException, ProcessInstanceNotFoundException
processInstanceId
- unique id of process instancenodeId
- node id to be triggered (new instance of that node to be created)NodeNotFoundException
- in case node with given id does not exist in process instanceProcessInstanceNotFoundException
- in case process instance id with given id was not foundvoid acknowledgeError(String... errorId) throws ExecutionErrorNotFoundException
errorId
- unique id of the errorExecutionErrorNotFoundException
- thrown when there is no unacknowledged error with that idorg.kie.internal.runtime.error.ExecutionError getError(String errorId) throws ExecutionErrorNotFoundException
errorId
- unique id of the errorExecutionErrorNotFoundException
- is thrown in case no error was found for given error idList<org.kie.internal.runtime.error.ExecutionError> getErrorsByProcessId(String deploymentId, String processId, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
deploymentId
- deployment id that contains given processprocessId
- process id of the processincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationList<org.kie.internal.runtime.error.ExecutionError> getErrorsByProcessInstanceId(long processInstanceId, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
processInstanceId
- process instance id of the processincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationList<org.kie.internal.runtime.error.ExecutionError> getErrorsByProcessInstanceId(long processInstanceId, String nodeName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
processInstanceId
- process instance id of the processnodeName
- name of the node that error should be found forincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationList<org.kie.internal.runtime.error.ExecutionError> getErrors(boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
includeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationCopyright © 2001–2018 JBoss by Red Hat. All rights reserved.