org.jbpm.kie.services.impl.admin

## Class ProcessInstanceAdminServiceImpl

- java.lang.Object
- - org.jbpm.kie.services.impl.admin.ProcessInstanceAdminServiceImpl

- All Implemented Interfaces:
    ProcessInstanceAdminService

      public class ProcessInstanceAdminServiceImpl
      extends Object
      implements ProcessInstanceAdminService

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ProcessInstanceAdminServiceImpl()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `acknowledgeError(String... errorId)` Acknowledge given error that it was reviewed and understood
    `protected void` | `applyQueryContext(Map<String,Object> params, org.kie.api.runtime.query.QueryContext queryContext)`
    `void` | `cancelNodeInstance(long processInstanceId, long nodeInstanceId)` Cancels node instance with given id within given process instance.
    `protected List<Short>` | `getAckMode(boolean includeAcknowledged)`
    `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>` | `getErrorsByDeploymentId(String containerId, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)` Returns all execution errors for a given deployment 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` | `setCommandService(TransactionalCommandService commandService)`
    `void` | `setIdentityProvider(org.kie.internal.identity.IdentityProvider identityProvider)`
    `void` | `setProcessService(ProcessService processService)`
    `void` | `setRuntimeDataService(RuntimeDataService runtimeDataService)`
    `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.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ProcessInstanceAdminServiceImpl

          public ProcessInstanceAdminServiceImpl()

  - ### Method Detail

    - #### setProcessService

          public void setProcessService(ProcessService processService)

    - #### setRuntimeDataService

          public void setRuntimeDataService(RuntimeDataService runtimeDataService)

    - #### setIdentityProvider

          public void setIdentityProvider(org.kie.internal.identity.IdentityProvider identityProvider)

    - #### setCommandService

          public void setCommandService(TransactionalCommandService commandService)

    - #### getProcessNodes

          public Collection<ProcessNode> getProcessNodes(long processInstanceId)
                                                  throws ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Returns all process nodes found in given process instance.
      Specified by:
        `getProcessNodes` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
      Returns:
        list of process nodes in process instance
      Throws:
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### cancelNodeInstance

          public void cancelNodeInstance(long processInstanceId,
                                         long nodeInstanceId)
                                  throws NodeInstanceNotFoundException,
                                         ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Cancels node instance with given id within given process instance.
      Specified by:
        `cancelNodeInstance` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
        `nodeInstanceId` - node instance id within given process instance to be canceled
      Throws:
        `NodeInstanceNotFoundException` - in case node instance with given id is not active
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### retriggerNodeInstance

          public void retriggerNodeInstance(long processInstanceId,
                                            long nodeInstanceId)
                                     throws NodeInstanceNotFoundException,
                                            ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Retriggers (which includes cancel) node instance given with node instance id within process instance.
      Specified by:
        `retriggerNodeInstance` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
        `nodeInstanceId` - node instance id within given process instance to be retriggered
      Throws:
        `NodeInstanceNotFoundException` - in case node instance with given id is not active
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### updateTimer

          public void updateTimer(long processInstanceId,
                                  long timerId,
                                  long delay,
                                  long period,
                                  int repeatLimit)
                           throws NodeInstanceNotFoundException,
                                  ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Updates active timer identified by timer id with delay that is given in seconds. Delay is absolute meaning it is as it would be set when timer was created.
      Example:
      In case timer was initially created with delay of 1 hour and after 30 min we decide to update it to 2 hours it will then expire in 1,5 hour from the time it was updated.
      Specified by:
        `updateTimer` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
        `timerId` - timer id that should be updated
        `delay` - absolute delay in seconds
        `period` - in case of repeatable timer how often it should repeat in milliseconds - if not applicable should be set to -1
        `repeatLimit` - in case of repeatable timer how many times it should trigger - if not applicable should be set to -1
      Throws:
        `NodeInstanceNotFoundException` - in case node instance with given id is not active
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### updateTimerRelative

          public void updateTimerRelative(long processInstanceId,
                                          long timerId,
                                          long delay,
                                          long period,
                                          int repeatLimit)
                                   throws NodeInstanceNotFoundException,
                                          ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Updates active timer identified by timer id with delay that is given in seconds and is relative to current time.
      Example:
      In case timer was initially created with delay of 1 hour and after 30 min we decide to update it to 2 hours it will then expire in 2 hours from the time it was updated.
      Specified by:
        `updateTimerRelative` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
        `timerId` - timer id that should be updated
        `delay` - absolute delay in seconds
        `period` - in case of repeatable timer how often it should repeat in milliseconds - if not applicable should be set to -1
        `repeatLimit` - in case of repeatable timer how many times it should trigger - if not applicable should be set to -1
      Throws:
        `NodeInstanceNotFoundException` - in case node instance with given id is not active
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### getTimerInstances

          public Collection<TimerInstance> getTimerInstances(long processInstanceId)
                                                      throws ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Returns active timers for given process instance.
      Specified by:
        `getTimerInstances` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
      Returns:
        list of timer found for given process instance
      Throws:
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### triggerNode

          public void triggerNode(long processInstanceId,
                                  long nodeId)
                           throws NodeNotFoundException,
                                  ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Triggers node to create new node instance with node id within process instance. This results in new instance of a task within process instance.
      Specified by:
        `triggerNode` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
        `nodeId` - node id to be triggered (new instance of that node to be created)
      Throws:
        `NodeNotFoundException` - in case node with given id does not exist in process instance
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### getActiveNodeInstances

          public Collection<NodeInstanceDesc> getActiveNodeInstances(long processInstanceId)
                                                              throws ProcessInstanceNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Returns all active node instances in given process instance;
      Specified by:
        `getActiveNodeInstances` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - unique id of process instance
      Returns:
        found active node instances
      Throws:
        `ProcessInstanceNotFoundException` - in case process instance id with given id was not found

    - #### acknowledgeError

          public void acknowledgeError(String... errorId)
                                throws ExecutionErrorNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Acknowledge given error that it was reviewed and understood
      Specified by:
        `acknowledgeError` in interface `ProcessInstanceAdminService`
      Parameters:
        `errorId` - unique id of the error
      Throws:
        `ExecutionErrorNotFoundException` - thrown when there is no unacknowledged error with that id

    - #### getError

          public org.kie.internal.runtime.error.ExecutionError getError(String errorId)
                                                                 throws ExecutionErrorNotFoundException

      Description copied from interface: `ProcessInstanceAdminService`
      Returns execution error identified by given error id
      Specified by:
        `getError` in interface `ProcessInstanceAdminService`
      Parameters:
        `errorId` - unique id of the error
      Returns:
        returns execution error instance
      Throws:
        `ExecutionErrorNotFoundException` - is thrown in case no error was found for given error id

    - #### getErrors

          public List<org.kie.internal.runtime.error.ExecutionError> getErrors(boolean includeAcknowledged,
                                                                               org.kie.api.runtime.query.QueryContext queryContext)

      Description copied from interface: `ProcessInstanceAdminService`
      Returns all execution errors regardless of their type
      Specified by:
        `getErrors` in interface `ProcessInstanceAdminService`
      Parameters:
        `includeAcknowledged` - indicates whether to include acknowledged errors or not
        `queryContext` - control parameters for pagination
      Returns:
        list of found errors

    - #### getErrorsByProcessId

          public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByProcessId(String deploymentId,
                                                                                          String processId,
                                                                                          boolean includeAcknowledged,
                                                                                          org.kie.api.runtime.query.QueryContext queryContext)

      Description copied from interface: `ProcessInstanceAdminService`
      Returns execution errors for given process id and deployment id
      Specified by:
        `getErrorsByProcessId` in interface `ProcessInstanceAdminService`
      Parameters:
        `deploymentId` - deployment id that contains given process
        `processId` - process id of the process
        `includeAcknowledged` - indicates whether to include acknowledged errors or not
        `queryContext` - control parameters for pagination
      Returns:
        list of found errors

    - #### getErrorsByProcessInstanceId

          public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByProcessInstanceId(long processInstanceId,
                                                                                                  boolean includeAcknowledged,
                                                                                                  org.kie.api.runtime.query.QueryContext queryContext)

      Description copied from interface: `ProcessInstanceAdminService`
      Returns execution errors for given process instance id
      Specified by:
        `getErrorsByProcessInstanceId` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - process instance id of the process
        `includeAcknowledged` - indicates whether to include acknowledged errors or not
        `queryContext` - control parameters for pagination
      Returns:
        list of found errors

    - #### getErrorsByProcessInstanceId

          public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByProcessInstanceId(long processInstanceId,
                                                                                                  String nodeName,
                                                                                                  boolean includeAcknowledged,
                                                                                                  org.kie.api.runtime.query.QueryContext queryContext)

      Description copied from interface: `ProcessInstanceAdminService`
      Returns execution errors for given process instance id and node
      Specified by:
        `getErrorsByProcessInstanceId` in interface `ProcessInstanceAdminService`
      Parameters:
        `processInstanceId` - process instance id of the process
        `nodeName` - name of the node that error should be found for
        `includeAcknowledged` - indicates whether to include acknowledged errors or not
        `queryContext` - control parameters for pagination
      Returns:
        list of found errors

    - #### getErrorsByDeploymentId

          public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByDeploymentId(String containerId,
                                                                                             boolean includeAcknowledged,
                                                                                             org.kie.api.runtime.query.QueryContext queryContext)

      Description copied from interface: `ProcessInstanceAdminService`
      Returns all execution errors for a given deployment regardless of their type
      Specified by:
        `getErrorsByDeploymentId` in interface `ProcessInstanceAdminService`
      Parameters:
        `containerId` - deployment id that contains the errors
        `includeAcknowledged` - indicates whether to include acknowledged errors or not
        `queryContext` - control parameters for pagination
      Returns:
        list of found errors

    - #### applyQueryContext

          protected void applyQueryContext(Map<String,Object> params,
                                           org.kie.api.runtime.query.QueryContext queryContext)

    - #### getAckMode

          protected List<Short> getAckMode(boolean includeAcknowledged)

Copyright © 2001–2021 JBoss by Red Hat. All rights reserved.