Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.stardust.engine.api.ejb2
Interface LocalWorkflowService

All Superinterfaces:
javax.ejb.EJBLocalObject
public interface LocalWorkflowService
extends javax.ejb.EJBLocalObject

The WorkflowService provides all functionality for workflow operations in a CARNOT runtime environment.

This includes:

Version:
60537
Author:
ubirkemeyer

Method Summary
 ActivityInstance abortActivityInstance(long activityInstanceOID)
          Aborts the specified activity instance, effectively aborting the whole process instance hierarchy this activity instance belongs to.
 ActivityInstance abortActivityInstance(long activityInstanceOid, AbortScope abortScope)
          Aborts the specified activity instance, effectively aborting the whole process instance hierarchy this activity instance belongs to.
 ProcessInstance abortProcessInstance(long processInstanceOid, AbortScope abortScope)
          Aborts the specified process instance.
 ActivityInstance activate(long activityInstanceOID)
          Activates the interactive activity instance identified by the activityInstanceOID.
 ActivityInstance activateAndComplete(long activityInstanceOID, java.lang.String context, java.util.Map outData)
          Activates and completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user.
 ActivityCompletionLog activateAndComplete(long activityInstanceOID, java.lang.String context, java.util.Map outData, int flags)
          Activates and completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user.
 ActivityInstance activateNextActivityInstance(long activityInstanceOID)
          Activates the next activity instance after the specified one in the same process instance.
 ActivityInstance activateNextActivityInstance(WorklistQuery query)
          Activates the next activity instance from the given worklist query if any.
 ActivityInstance activateNextActivityInstanceForProcessInstance(long processInstanceOID)
          Activates the next activity instance for the specified process instance.
 ActivityInstance bindActivityEventHandler(long activityInstanceOID, EventHandlerBinding eventHandler)
          Binds an event handler to the specified activity instance.
 ActivityInstance bindActivityEventHandler(long activityInstanceOID, java.lang.String handler)
          Binds an event handler to the specified activity instance.
 ProcessInstance bindProcessEventHandler(long processInstanceOID, EventHandlerBinding eventHandler)
          Binds an event handler to the specified process instance.
 ProcessInstance bindProcessEventHandler(long processInstanceOID, java.lang.String handler)
          Binds an event handler to the specified process instance.
 ActivityInstance complete(long activityInstanceOID, java.lang.String context, java.util.Map outData)
          Completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user.
 ActivityCompletionLog complete(long activityInstanceOID, java.lang.String context, java.util.Map outData, int flags)
          Completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user.
 ProcessInstance createCase(java.lang.String name, java.lang.String description, long[] memberOids)
          Creates a case process instance which groups the specified members as subprocesses.
 ProcessInstance delegateCase(long caseOid, ParticipantInfo participant)
          Delegates the case process instance to the specified participant.
 ActivityInstance delegateToDefaultPerformer(long activityInstanceOID)
          Delegates the specified activitiy instance to the default worklist of the corresponding activity.
 ActivityInstance delegateToParticipant(long activityInstanceOID, ParticipantInfo participant)
          Delegates the activity instance to the specified participant as follows: if the participant is null, then delegates the activity to the default performer. if the participant is an instance of a UserInfo, then delegates the activity to the specified user. if the participant is an instance of a UserGroupInfo, then delegates the activity to the specified user group. if the participant is an instance of a ModelParticipantInfo, then delegates the activity to the specified model participant.
 ActivityInstance delegateToParticipant(long activityInstanceOID, java.lang.String performer)
          Delegates the specified activity instance to a specific performer.
 ActivityInstance delegateToUser(long activityInstanceOID, long userOID)
          Delegates the specified activity instance to a specific performer.
 java.io.Serializable execute(ServiceCommand serviceCmd)
          Executes a ServiceCommand in a single engine transaction.
 ActivityInstance getActivityInstance(long activityInstanceOID)
          Retrieves the specified ActivityInstance.
 EventHandlerBinding getActivityInstanceEventHandler(long activityInstanceOID, java.lang.String handler)
          Gets the binding state of an event handler for the specified activity instance.
 java.util.List<TransitionTarget> getAdHocTransitionTargets(long activityInstanceOid, TransitionOptions options, ScanDirection direction)
          Retrieves the possible targets for forward transitions starting from the specified activity instance.
 java.lang.Object getInDataPath(long processInstanceOID, java.lang.String id)
          Retrieves an IN data path on a process instance as specified in the corresponding process definition.
 java.util.Map<java.lang.String,java.io.Serializable> getInDataPaths(long processInstanceOID, java.util.Set ids)
          Retrieves multiple IN data paths from a process instance as specified in the corresponding process definition.
 java.io.Serializable getInDataValue(long activityInstanceOID, java.lang.String context, java.lang.String id)
          Retrieves all evaluated IN data mappings that match the provided application context for the specified activity.
 java.util.Map<java.lang.String,java.io.Serializable> getInDataValues(long activityInstanceOID, java.lang.String context, java.util.Set ids)
          Retrieves all evaluated IN data mappings that match the provided application context for the specified activity.
 DeployedModel getModel()
          Deprecated. Retrieves the active model.
 java.util.List<Permission> getPermissions()
          Retrieves all permissions the current user has on this service.
 ProcessInstance getProcessInstance(long processInstanceOID)
          Retrieves the specified process instance.
 EventHandlerBinding getProcessInstanceEventHandler(long processInstanceOID, java.lang.String handler)
          Gets the binding state of an event handler for the specified process instance.
 java.util.Map<java.lang.String,java.io.Serializable> getProcessResults(long processInstanceOID)
          TODO
 java.util.List<ProcessDefinition> getStartableProcessDefinitions()
          Retrieves the list of process definitions that can be started by the current user.
 User getUser()
          Retrieves information on the current user.
 Worklist getWorklist(WorklistQuery query)
          Retrieves (parts of) the worklist of the currently logged-in user.
 ActivityInstance hibernate(long activityInstanceOID)
          Change the state of the specified activity instance to HIBERNATED.
 ProcessInstance joinCase(long caseOid, long[] memberOids)
          Adds the process instances referenced by the specified memberOids to the specified case process instance.
 ProcessInstance joinProcessInstance(long processInstanceOid, long targetProcessInstanceOid, java.lang.String comment)
          Aborts the specified process instance and joins the data into the specified target process instance.
 ProcessInstance leaveCase(long caseOid, long[] memberOids)
          Removes the process instances referenced by the specified memberOids from the specified case process instance.
 void login(java.lang.String userId, java.lang.String password)
           
 void login(java.lang.String userId, java.lang.String password, java.util.Map properties)
           
 void logout()
           
 ProcessInstance mergeCases(long targetCaseOid, long[] sourceCaseOids, java.lang.String comment)
          Merges the specified source case process instances into the target case process instance by adding all case members of the source case process instances as members of the target case process instance.
 ActivityInstance performAdHocTransition(long activityInstanceOid, TransitionTarget target, boolean complete)
          Performs the transition from the specified activity instance to the specified target.
 void setActivityInstanceAttributes(ActivityInstanceAttributes attributes)
          Sets attributes for an activity instance
 void setOutDataPath(long processInstanceOID, java.lang.String id, java.lang.Object object)
          Sets an OUT data path on a process instance as specified in the corresponding process definition.
 void setOutDataPaths(long processInstanceOID, java.util.Map values)
          Sets multiple OUT data paths on a process instance as specified in the corresponding process definition.
 void setProcessInstanceAttributes(ProcessInstanceAttributes attributes)
          Sets specific attributes of a process instance.
 ProcessInstance spawnPeerProcessInstance(long processInstanceOid, java.lang.String spawnProcessID, boolean copyData, java.util.Map data, boolean abortProcessInstance, java.lang.String comment)
          Spawns a new root process and creates a link of type ProcessInstanceLinkType#SWITCH to the specified process instance.
Optionally existing data from the specified process instance can be copied to the newly spawned process.
 ProcessInstance spawnPeerProcessInstance(long processInstanceOid, java.lang.String spawnProcessID, SpawnOptions options)
          Spawns a new root process and creates a link of type ProcessInstanceLinkType#SWITCH to the specified process instance.
Optionally existing data from the specified process instance can be copied to the newly spawned process.
 ProcessInstance spawnSubprocessInstance(long parentProcessInstanceOid, java.lang.String spawnProcessID, boolean copyData, java.util.Map data)
          Spawns a process as subprocess of the specified process instance.
 java.util.List<ProcessInstance> spawnSubprocessInstances(long parentProcessInstanceOid, java.util.List subprocessSpawnInfo)
          Spawns multiple processes as subprocesses of the specified process instance.
 ProcessInstance startProcess(java.lang.String id, java.util.Map data, boolean synchronously)
          Starts the process specified by the given ID using the provided data and returns the OID of the newly created process instance.
 ActivityInstance suspend(long activityInstanceOID, ContextData outData)
          Suspends the specified activity instance.
 ActivityInstance suspendToDefaultPerformer(long activityInstanceOID)
          Suspends the specified activity instance.
 ActivityInstance suspendToDefaultPerformer(long activityInstanceOID, java.lang.String context, java.util.Map outData)
          Suspends the specified activity instance.
 ActivityInstance suspendToParticipant(long activityInstanceOID, ParticipantInfo participant, ContextData outData)
          Suspends the activity instance and, if the participant is not null, delegates it to the specified participant.
 ActivityInstance suspendToParticipant(long activityInstanceOID, java.lang.String participant)
          Suspends the specified activity instance.
 ActivityInstance suspendToParticipant(long activityInstanceOID, java.lang.String participant, java.lang.String context, java.util.Map outData)
          Suspends the specified activity instance.
 ActivityInstance suspendToUser(long activityInstanceOID)
          Suspends the specified activity instance.
 ActivityInstance suspendToUser(long activityInstanceOID, long userOID)
          Suspends the specified activity instance.
 ActivityInstance suspendToUser(long activityInstanceOID, long userOID, java.lang.String context, java.util.Map outData)
          Suspends the specified activity instance.
 ActivityInstance suspendToUser(long activityInstanceOID, java.lang.String context, java.util.Map outData)
          Suspends the specified activity instance.
 ActivityInstance unbindActivityEventHandler(long activityInstanceOID, java.lang.String handler)
          Unbinds an event handler from the specified activity instance.
 ProcessInstance unbindProcessEventHandler(long processInstanceOID, java.lang.String handler)
          Unbinds an event handler from the specified process instance.
 void writeLogEntry(LogType logType, ContextKind contextType, long contextOid, java.lang.String message, java.lang.Throwable throwable)
          Logs an audit trail event of type LogCode.EXTERNAL.
 
Methods inherited from interface javax.ejb.EJBLocalObject
getEJBLocalHome, getPrimaryKey, isIdentical, remove
 

Method Detail

activate

ActivityInstance activate(long activityInstanceOID)
                          throws WorkflowException
Activates the interactive activity instance identified by the activityInstanceOID.

Activating means:

State changes:

Parameters:
activityInstanceOID - the OID of the activity to be activated.
Returns:
the ActivityInstance that was activated.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not valid or is not granted to execute the activity instance. Also thrown if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the current user is the one who worked on the previous workflow instance. Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
activateAndComplete(long, java.lang.String, java.util.Map), WorkflowService.activate( long activityInstanceOID)

complete

ActivityInstance complete(long activityInstanceOID,
                          java.lang.String context,
                          java.util.Map outData)
                          throws WorkflowException
Completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user.

State Changes:

Parameters:
activityInstanceOID - the OID of the activity to be completed.
context - the ID of the context on which the data mapping will be performed.
outData - a map with the values of the out access points.
Returns:
the ActivityInstance that was completed.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the activity instance is exclusively locked by another thread. Instances of ConcurrencyException will be wrapped inside WorkflowException.
IllegalStateChangeException - if that state change is not permitted, i.e. the activity is not active. Instances of IllegalStateChangeException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if one of the outData values to be written is invalid, most probably as of a type conflict in case of statically typed data. Instances of InvalidValueException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not allowed to complete the activity. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance and no {@link org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes} has been set before({@link ({@link WorkflowService#setorg.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes( org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes)}). Instances of {@link org.eclipse.stardust.engine.api.runtime.IllegalOperationException} will be wrapped inside {@link org.eclipse.stardust.engine.api.ejb2.WorkflowException}.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
activateAndComplete(long, String, Map), complete(long, String, Map, int), WorkflowService.complete( long activityInstanceOID, java.lang.String context, java.util.Map outData)

complete

ActivityCompletionLog complete(long activityInstanceOID,
                               java.lang.String context,
                               java.util.Map outData,
                               int flags)
                               throws WorkflowException
Completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user.

State Changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: completed
  • Process state after: Completed if all activities are completed. Otherwise state does not change.

Parameters:
activityInstanceOID - the OID of the activity to be completed.
context - the ID of the context on which the data mapping will be performed.
outData - a map with the values of the out access points.
flags - Optional adjustment to some details of operation. Supported values are #FLAG_ACTIVATE_NEXT_ACTIVITY_INSTANCE.
Returns:
A log describing the result of the invocation. Depends on the flags parameter.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
IllegalStateChangeException - if that state change is not permitted, i.e. the activity is not active. Instances of IllegalStateChangeException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if one of the outData values to be written is invalid, most probably as of a type conflict in case of statically typed data. Instances of InvalidValueException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance and no {@link org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes} has been set before({@link ({@link WorkflowService#setorg.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes( org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes)}). Instances of {@link org.eclipse.stardust.engine.api.runtime.IllegalOperationException} will be wrapped inside {@link org.eclipse.stardust.engine.api.ejb2.WorkflowException}.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
complete(long, String, Map), activateAndComplete(long, String, Map), WorkflowService.complete( long activityInstanceOID, java.lang.String context, java.util.Map outData, int flags)

activateAndComplete

ActivityInstance activateAndComplete(long activityInstanceOID,
                                     java.lang.String context,
                                     java.util.Map outData)
                                     throws WorkflowException
Activates and completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user. If the activity is activated to be immediately completed, this method is more efficient than invoking activate(...) and complete(...) separately.

Parameters:
activityInstanceOID - the OID of the activity to be completed.
context - the ID of the context on which the data mapping will be performed. The value null will be interpreted as the default context.
outData - a map with the values of the out access points.
Returns:
the ActivityInstance that was completed.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if one of the outData values to be written is invalid, most probably as of a type conflict in case of statically typed data. Instances of InvalidValueException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not valid or is not granted to execute the activity instance. Also thrown if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the current user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance and no {@link org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes} has been set before({@link ({@link WorkflowService#setorg.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes( org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes)}). Instances of {@link org.eclipse.stardust.engine.api.runtime.IllegalOperationException} will be wrapped inside {@link org.eclipse.stardust.engine.api.ejb2.WorkflowException}.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
activate(long), complete(long, String, Map), activateAndComplete(long, String, Map, int), WorkflowService.activateAndComplete( long activityInstanceOID, java.lang.String context, java.util.Map outData)

activateAndComplete

ActivityCompletionLog activateAndComplete(long activityInstanceOID,
                                          java.lang.String context,
                                          java.util.Map outData,
                                          int flags)
                                          throws WorkflowException
Activates and completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user. If the activity is activated to be immediately completed, this method is more efficient than invoking activate(...) and complete(...) separately.

Parameters:
activityInstanceOID - the OID of the activity to be completed.
context - the ID of the context on which the data mapping will be performed. The value null will be interpreted as the default context.
outData - a map with the values of the out access points.
flags - Optional adjustment to some details of operation. Supported values are #FLAG_ACTIVATE_NEXT_ACTIVITY_INSTANCE.
Returns:
A log describing the result of the invocation. Depends on the flags parameter.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if one of the outData values to be written is invalid, most probably as of a type conflict in case of statically typed data. Instances of InvalidValueException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the current user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not valid or is not granted to execute the activity instance. Also thrown if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance and no {@link org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes} has been set before({@link ({@link WorkflowService#setorg.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes( org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes)}). Instances of {@link org.eclipse.stardust.engine.api.runtime.IllegalOperationException} will be wrapped inside {@link org.eclipse.stardust.engine.api.ejb2.WorkflowException}.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
activateAndComplete(long, String, Map), activate(long), complete(long, String, Map), WorkflowService.activateAndComplete( long activityInstanceOID, java.lang.String context, java.util.Map outData, int flags)

getInDataValue

java.io.Serializable getInDataValue(long activityInstanceOID,
                                    java.lang.String context,
                                    java.lang.String id)
                                    throws WorkflowException
Retrieves all evaluated IN data mappings that match the provided application context for the specified activity.

Parameters:
activityInstanceOID - the OID of the activity for which the data mappings are to be retrieved.
context - the application context for which the mappings are retrieved. The value null will be interpreted as the default context.
id - The ID of the data mapping to be retrieved.
Returns:
The retrieved value.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID or there is no mapping with the given ID under the given context. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
Since:
3.1.2
See Also:
getInDataValues(long, String, Set), WorkflowService.getInDataValue( long activityInstanceOID, java.lang.String context, java.lang.String id)

getInDataValues

java.util.Map<java.lang.String,java.io.Serializable> getInDataValues(long activityInstanceOID,
                                                                     java.lang.String context,
                                                                     java.util.Set ids)
                                                                     throws WorkflowException
Retrieves all evaluated IN data mappings that match the provided application context for the specified activity.

Parameters:
activityInstanceOID - the OID of the activity for which the data mappings are to be retrieved.
context - the application context for which the mappings are retrieved. The value null will be interpreted as the default context.
ids - the set of data mapping IDs designating the values to be retrieved. If null is passed, all IN data mappings for the context are retrieved.
Returns:
A Map with corresponding (data mapping ID, data value)-pairs. Data values are Serializable.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID or not all mapping IDs can be resolved in the given context. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
Since:
3.1.2
See Also:
getInDataValue(long, String, String), WorkflowService.getInDataValues( long activityInstanceOID, java.lang.String context, java.util.Set ids)

suspend

ActivityInstance suspend(long activityInstanceOID,
                         ContextData outData)
                         throws WorkflowException
Suspends the specified activity instance. It will be added to the same worklist in which it was prior to activation, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
outData - the context data containing values of out access points to be stored.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated or is currently processed by another user or the current user does not have the required permission. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToDefaultPerformer(long, String, Map), WorkflowService.suspend( long activityInstanceOID, org.eclipse.stardust.engine.api.model.ContextData outData)

suspendToDefaultPerformer

ActivityInstance suspendToDefaultPerformer(long activityInstanceOID)
                                           throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the default performer declared for the corresponding activity, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToDefaultPerformer(long, String, Map), WorkflowService.suspendToDefaultPerformer( long activityInstanceOID)

suspendToDefaultPerformer

ActivityInstance suspendToDefaultPerformer(long activityInstanceOID,
                                           java.lang.String context,
                                           java.util.Map outData)
                                           throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the default performer declared for the corresponding activity, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
context - the ID of the context on which the data mapping will be performed.
outData - a map with values of out access points to be stored.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToDefaultPerformer(long), WorkflowService.suspendToDefaultPerformer( long activityInstanceOID, java.lang.String context, java.util.Map outData)

suspendToUser

ActivityInstance suspendToUser(long activityInstanceOID)
                               throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the current user, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToUser(long, String, Map), WorkflowService.suspendToUser( long activityInstanceOID)

suspendToUser

ActivityInstance suspendToUser(long activityInstanceOID,
                               java.lang.String context,
                               java.util.Map outData)
                               throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the current user, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
context - the ID of the context on which the data mapping will be performed.
outData - a map with values of out access points to be stored.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToUser(long), WorkflowService.suspendToUser( long activityInstanceOID, java.lang.String context, java.util.Map outData)

suspendToUser

ActivityInstance suspendToUser(long activityInstanceOID,
                               long userOID)
                               throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the provided user, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
userOID - the OID of the user.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the specified user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToUser(long, long, String, Map), WorkflowService.suspendToUser( long activityInstanceOID, long userOID)

suspendToUser

ActivityInstance suspendToUser(long activityInstanceOID,
                               long userOID,
                               java.lang.String context,
                               java.util.Map outData)
                               throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the provided user, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
userOID - the OID of the user.
context - the ID of the context on which the data mapping will be performed.
outData - a map with values of out access points to be stored.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the specified user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToUser(long, long), WorkflowService.suspendToUser( long activityInstanceOID, long userOID, java.lang.String context, java.util.Map outData)

suspendToParticipant

ActivityInstance suspendToParticipant(long activityInstanceOID,
                                      java.lang.String participant)
                                      throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the provided performer, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
participant - the ID of the performer.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToParticipant(long, String, String, Map), WorkflowService.suspendToParticipant( long activityInstanceOID, java.lang.String participant)

suspendToParticipant

ActivityInstance suspendToParticipant(long activityInstanceOID,
                                      java.lang.String participant,
                                      java.lang.String context,
                                      java.util.Map outData)
                                      throws WorkflowException
Suspends the specified activity instance. It will be added to the worklist of the provided performer, and the specified activity instance will be set to SUSPENDED state.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity to be suspended.
participant - the ID of the performer.
context - the ID of the context on which the data mapping will be performed.
outData - a map with values of out access points to be stored.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
suspendToParticipant(long, String), WorkflowService.suspendToParticipant( long activityInstanceOID, java.lang.String participant, java.lang.String context, java.util.Map outData)

suspendToParticipant

ActivityInstance suspendToParticipant(long activityInstanceOID,
                                      ParticipantInfo participant,
                                      ContextData outData)
                                      throws WorkflowException
Suspends the activity instance and, if the participant is not null, delegates it to the specified participant.

State changes:

  • Activity state before: application
  • Process state before: active, interrupted
  • Activity state after: suspended
  • Process state after: State does not change.

Parameters:
activityInstanceOID - the OID of the activity instance.
participant - the participant ( model participant, user or user group) to which the activity instance will be delegated.
outData - the context data containing values of out access points to be stored.
Returns:
the ActivityInstance that was suspended.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID or if the participant is not null and could not be resolved to an actual user user group or model participant. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated or is currently processed by another user or the current user does not have the required permission or if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the passed participant is a user who worked on the previous workflow orkflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.suspendToParticipant( long activityInstanceOID, org.eclipse.stardust.engine.api.model.ParticipantInfo participant, org.eclipse.stardust.engine.api.model.ContextData outData)

hibernate

ActivityInstance hibernate(long activityInstanceOID)
                           throws WorkflowException
Change the state of the specified activity instance to HIBERNATED.

Parameters:
activityInstanceOID - the OID of the activity to be hibernated.
Returns:
the ActivityInstance that was hibernated.
Throws:
IllegalStateChangeException - if that state change is not permitted, i.e. the activity is already completed or aborted. Instances of IllegalStateChangeException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.hibernate( long activityInstanceOID)

startProcess

ProcessInstance startProcess(java.lang.String id,
                             java.util.Map data,
                             boolean synchronously)
                             throws WorkflowException
Starts the process specified by the given ID using the provided data and returns the OID of the newly created process instance.

State changes:

  • Process state after: active

Parameters:
id - The ID of the process to be started. If multiple models with different IDs are deployed then the process definition id needs to be qualified with model model id, e.g. "{modelId}processDefinitionId"
data - Contains data IDs as keyset and corresponding data values to be set as values.
synchronously - Determines whether the process will be started synchronously or asynchronously.
Returns:
the ProcessInstance that was started.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process with the specified ID in the active model or an invalid data id was specified. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.startProcess( java.lang.String id, java.util.Map data, boolean synchronously)

spawnSubprocessInstance

ProcessInstance spawnSubprocessInstance(long parentProcessInstanceOid,
                                        java.lang.String spawnProcessID,
                                        boolean copyData,
                                        java.util.Map data)
                                        throws WorkflowException
Spawns a process as subprocess of the specified process instance. The spawned process executes asynchronously but has to be completed before the parent process is able to complete.

Parameters:
parentProcessInstanceOid - The oid of the process to spawn from.
spawnProcessID - The id of the process definition to spawn as a subprocess.
copyData - Defines if data of the parent process definition should be copied to the spawned process.
data - Contains data IDs as keyset and corresponding data values to be set as values.
Returns:
the ProcessInstance that was spawned.
Throws:
IllegalOperationException - if the process instance is not a case process instance, is not active or if the process definition is from a different model. Instances of IllegalOperationException will be wrapped inside WorkflowException.
ObjectNotFoundException - if there is no process instance with the specified oid or if there is no process definition with the specified id. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on transitions or process instances cannot be obtained. This can happen while the process hierarchy is currently locked because of case operations or subprocess creation. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.spawnSubprocessInstance( long parentProcessInstanceOid, java.lang.String spawnProcessID, boolean copyData, java.util.Map data)

spawnSubprocessInstances

java.util.List<ProcessInstance> spawnSubprocessInstances(long parentProcessInstanceOid,
                                                         java.util.List subprocessSpawnInfo)
                                                         throws WorkflowException
Spawns multiple processes as subprocesses of the specified process instance. The spawned processes execute asynchronously but have to be completed before the parent process is able to complete.

Parameters:
parentProcessInstanceOid - The oid of the process to spawn from.
subprocessSpawnInfo - A List of SubprocessSpawnInfo holding information about the subprocesses to be spawned.
Returns:
A list of ProcessInstance that were spawned.
Throws:
IllegalOperationException - if the process instance is not a case process instance, is not active or if the process definition is from a different model. Instances of IllegalOperationException will be wrapped inside WorkflowException.
ObjectNotFoundException - if there is no process instance with the specified oid or if there is no process definition with the specified id. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on transitions or process instances cannot be obtained. This can happen while the process hierarchy is currently locked because of case operations or subprocess creation. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.spawnSubprocessInstances( long parentProcessInstanceOid, java.util.List subprocessSpawnInfo)

spawnPeerProcessInstance

ProcessInstance spawnPeerProcessInstance(long processInstanceOid,
                                         java.lang.String spawnProcessID,
                                         boolean copyData,
                                         java.util.Map data,
                                         boolean abortProcessInstance,
                                         java.lang.String comment)
                                         throws WorkflowException
Spawns a new root process and creates a link of type ProcessInstanceLinkType#SWITCH to the specified process instance.
Optionally existing data from the specified process instance can be copied to the newly spawned process.

Please note that currently the specified process instance has to be aborted by setting abortProcessInstance to true.

Parameters:
processInstanceOid - The oid of the process to spawn from.
spawnProcessID - The id of the process definition to spawn as a new root process.
copyData - Defines if data of the parent process definition should be copied to the spawned process.
data - Contains data IDs as keyset and corresponding data values to be set as values.
abortProcessInstance - whether the originating process instance should be aborted. Currently has to be true.
comment - Allows to specify a comment for the link that is created.
Returns:
The ProcessInstance that was spawned.
Throws:
IllegalOperationException - if the process instance is terminated or not a root process instance. if the process instance and the process definition are from different different models. if the process instances process definition is the same as the specified process ed process definition. Instances of IllegalOperationException will be wrapped inside WorkflowException.
ObjectNotFoundException - if the process instance for the specified oid or the process definition for the specified process id is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
InvalidArgumentException - if abortProcessInstance is false (currently not implemented). Instances of InvalidArgumentException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on process instances cannot be obtained. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.spawnPeerProcessInstance( long processInstanceOid, java.lang.String spawnProcessID, boolean copyData, java.util.Map data, boolean abortProcessInstance, java.lang.String comment)

spawnPeerProcessInstance

ProcessInstance spawnPeerProcessInstance(long processInstanceOid,
                                         java.lang.String spawnProcessID,
                                         SpawnOptions options)
                                         throws WorkflowException
Spawns a new root process and creates a link of type ProcessInstanceLinkType#SWITCH to the specified process instance.
Optionally existing data from the specified process instance can be copied to the newly spawned process.

Please note that currently the specified process instance has to be aborted by setting abortProcessInstance to true.

Parameters:
processInstanceOid - The oid of the process to spawn from.
spawnProcessID - The id of the process definition to spawn as a new root process.
options - Options that controls how the spawning operation has to be performed.
Returns:
The ProcessInstance that was spawned.
Throws:
IllegalOperationException - if the process instance is terminated or not a root process instance. if the process instance and the process definition are from different different models. if the process instances process definition is the same as the specified process ed process definition. Instances of IllegalOperationException will be wrapped inside WorkflowException.
ObjectNotFoundException - if the process instance for the specified oid or the process definition for the specified process id is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
InvalidArgumentException - if abortProcessInstance is false (currently not implemented). Instances of InvalidArgumentException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on process instances cannot be obtained. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.spawnPeerProcessInstance( long processInstanceOid, java.lang.String spawnProcessID, org.eclipse.stardust.engine.api.runtime.SpawnOptions options)

createCase

ProcessInstance createCase(java.lang.String name,
                           java.lang.String description,
                           long[] memberOids)
                           throws WorkflowException
Creates a case process instance which groups the specified members as subprocesses.

Parameters:
name - The name of the case.
description - A description for the case.
memberOids - The oids of the process instances which should become members of the case.
Returns:
The case process instance.
Throws:
ObjectNotFoundException - if one of the process instances referenced by memberOids is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if memberOids contains a process instance which is not a root process. Instances of IllegalOperationException will be wrapped inside WorkflowException.
InvalidArgumentException - if memberOids is empty or null. Instances of InvalidArgumentException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on transitions or process instances cannot be obtained. This can happen while the process hierarchy is currently locked because of case operations or subprocess creation. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.createCase( java.lang.String name, java.lang.String description, long[] memberOids)

joinCase

ProcessInstance joinCase(long caseOid,
                         long[] memberOids)
                         throws WorkflowException
Adds the process instances referenced by the specified memberOids to the specified case process instance.

Parameters:
caseOid - The oid of the case process instance.
memberOids - The oids of the process instances which should become members of the case.
Returns:
The case process instance.
Throws:
ObjectNotFoundException - if one of the process instances referenced by memberOids is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if memberOids contains a process instance which is not a root process or is already a member of the case. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the user is not the owner of the case. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on transitions or process instances cannot be obtained. This can happen while the process hierarchy is currently locked because of case operations or subprocess creation. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.joinCase( long caseOid, long[] memberOids)

leaveCase

ProcessInstance leaveCase(long caseOid,
                          long[] memberOids)
                          throws WorkflowException
Removes the process instances referenced by the specified memberOids from the specified case process instance.

Parameters:
caseOid - The oid of the case process instance.
memberOids - The oids of the process instances which should be removed from the case.
Returns:
The case process instance.
Throws:
ObjectNotFoundException - if one of the process instances referenced by memberOids is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if memberOids contains a process instance which is not a root process or is not a member of the case. Instances of IllegalOperationException will be wrapped inside WorkflowException.
AccessForbiddenException - if the user is not the owner of the case. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on transitions or process instances cannot be obtained. This can happen while the process hierarchy is currently locked because of case operations or subprocess creation. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.leaveCase( long caseOid, long[] memberOids)

mergeCases

ProcessInstance mergeCases(long targetCaseOid,
                           long[] sourceCaseOids,
                           java.lang.String comment)
                           throws WorkflowException
Merges the specified source case process instances into the target case process instance by adding all case members of the source case process instances as members of the target case process instance.

Parameters:
targetCaseOid - The target case process instance
sourceCaseOids - The source case process instances.
comment - Allows to specify a comment
Returns:
The case process instance.
Throws:
ObjectNotFoundException - if one of the process instances referenced by sourceCaseOids ids is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if sourceCaseOids contains a process instance which is not a case process instance. if sourceCaseOids contains a process instance which is not ich is not active. if sourceCaseOids contains a process instance which equals the equals the targetCaseOid. if targetCaseOid is not a case process instance. Instances of IllegalOperationException will be wrapped inside WorkflowException.
AccessForbiddenException - if the user is not the owner of the case. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
ConcurrencyException - if a lock on transitions or process instances cannot be obtained. This can happen while the process hierarchy is currently locked because of case operations or subprocess creation. Instances of ConcurrencyException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.mergeCases( long targetCaseOid, long[] sourceCaseOids, java.lang.String comment)

delegateCase

ProcessInstance delegateCase(long caseOid,
                             ParticipantInfo participant)
                             throws WorkflowException
Delegates the case process instance to the specified participant.

Parameters:
caseOid - The case process instance to delegate.
participant - The targetParticipant.
Returns:
The case process instance.
Throws:
ObjectNotFoundException - if one of the process instances referenced by caseOid is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if caseOid is not a case process instance. Instances of IllegalOperationException will be wrapped inside WorkflowException.
AccessForbiddenException - if the user is not the owner of the case. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the specified user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.delegateCase( long caseOid, org.eclipse.stardust.engine.api.model.ParticipantInfo participant)

joinProcessInstance

ProcessInstance joinProcessInstance(long processInstanceOid,
                                    long targetProcessInstanceOid,
                                    java.lang.String comment)
                                    throws WorkflowException
Aborts the specified process instance and joins the data into the specified target process instance. Existing data values of the target process instance are not overwritten. Process attachments are merged.

Parameters:
processInstanceOid - The oid of the process instance which should be aborted and joined into the target process instance.
targetProcessInstanceOid - The oid of the process instance that should be the target of the join.
comment - Allows specifying a comment.
Returns:
The target process instance.
Throws:
ObjectNotFoundException - if the process instance referenced by processInstanceOid or targetProcessInstanceOid do not exist. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
IllegalOperationException - if the source and target are identical.
if the source or target are not active.
if the join target is a subprocess of the source process instance.
if the source or target is a case process instance. Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.joinProcessInstance( long processInstanceOid, long targetProcessInstanceOid, java.lang.String comment)

abortActivityInstance

ActivityInstance abortActivityInstance(long activityInstanceOID)
                                       throws WorkflowException
Aborts the specified activity instance, effectively aborting the whole process instance hierarchy this activity instance belongs to.

Aborting an activity instance is only allowed if the activity was modeled to be abortable (@see Activity#isAbortable()}). Additionally it is required that the aborting user is a valid performing participant for this activity.

Behavior is equivalent to WorkflowService#abortActivityInstance(long, AbortScope) using AbortScope.RootHierarchy.

Note: Abort is performed asynchronously.

State changes

  • Activity state before: suspended, application, interrupted, hibernated
  • Process state before: active, interrupted
  • State after:
    If abort scope is root hierarchy: The state of the specified activity, its root process, all contained sub-processes and activities that are not yet completed changes to aborted.
    If abort scope is sub hierarchy: The state of the specified activity changes to aborted. If activity instance is a subprocess then the state of contained subprocesses and activities also changes to aborted.
    If the last activity of the process is aborted and is not a subprocess then the process state will be set to completed.

Parameters:
activityInstanceOID - The OID of the activity instance to be aborted.
Returns:
The ActivityInstance that was aborted.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID in the audit trail. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not valid or is not granted access to the activity instance. Also thrown if the activity instance is already terminated or if the activity is not allowed to be aborted. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
AdministrationService.abortProcessInstance( long), WorkflowService.abortActivityInstance( long, AbortScope), WorkflowService.abortActivityInstance( long activityInstanceOID)

abortActivityInstance

ActivityInstance abortActivityInstance(long activityInstanceOid,
                                       AbortScope abortScope)
                                       throws WorkflowException
Aborts the specified activity instance, effectively aborting the whole process instance hierarchy this activity instance belongs to.

Aborting an activity instance is only allowed if the activity was modeled to be abortable (see Activity#isAbortable()). Additionally it is required that the aborting user is a valid performing participant for this activity.

Note: Abort is performed asynchronously.

State changes

  • Activity state before: suspended, application, interrupted, hibernated
  • Process state before: active, interrupted
  • State after:
    If abort scope is root hierarchy: The state of the specified activity, its root process, all contained sub-processes and activities that are not yet completed changes to aborted.
    If abort scope is sub hierarchy: The state of the specified activity changes to aborted. If activity instance is a subprocess then the state of contained subprocesses and activities also changes to aborted.
    If the last activity of the process is aborted and is not a subprocess then the process state will be set to completed.

Parameters:
activityInstanceOID - The OID of the activity instance to be aborted.
abortScope - The scope of abortion. You can either choose the current activity or the entire process hierarchy.
If you have chosen AbortScope.SubHierarchy then the specified activity instance is set to state ActivityInstanceState.Aborting. The abort itself is performed asynchronously. If activity instance is a is a subprocess then the complete subprocess hierarchy will be aborted.
If you have chosen AbortScope.RootHierarchy abortion is done starting at the root process instance for specified activity instance. The specified activity instance will be returned unchanged. The state of the root process instance will be set to ProcessInstanceState.Aborting. Abort itself will be performed asynchronously.
Returns:
The ActivityInstance that was aborted.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID in the audit trail. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not valid or is not granted access to the activity instance. Also thrown if the activity instance is already terminated or if the activity is not allowed to be aborted. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
AdministrationService.abortProcessInstance( long), WorkflowService.abortActivityInstance(long), WorkflowService.abortActivityInstance( long activityInstanceOid, org.eclipse.stardust.engine.core.runtime.beans.AbortScope abortScope)

abortProcessInstance

ProcessInstance abortProcessInstance(long processInstanceOid,
                                     AbortScope abortScope)
                                     throws WorkflowException
Aborts the specified process instance. Depending on the scope, it will abort either this process instance only (including eventual subprocesses) or the whole process hierarchy starting with the root process.

State changes:

  • Process state before: active, interrupted
  • State after:
    If abort scope is root hierarchy: The state of root process, all sub-processes and activities that are not yet completed changes to aborted.

    • If abort scope is sub hierarchy: The state of the sub-process, all its subprocesses and activities that are not yet completed changes to aborted.

Parameters:
processInstanceOid - The OID of the process instance to be aborted.
abortScope - The scope of abortion. You can abort either the spawned process instance or the entire process hierarchy.
Returns:
The ProcessInstance that was aborted.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID in the audit trail. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not valid or is not granted access to abort the process instance. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.abortProcessInstance( long processInstanceOid, org.eclipse.stardust.engine.core.runtime.beans.AbortScope abortScope)

getModel

DeployedModel getModel()
                       throws WorkflowException
Deprecated. Retrieves the active model.

Returns:
the active model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getModel()

getWorklist

Worklist getWorklist(WorklistQuery query)
                     throws WorkflowException
Retrieves (parts of) the worklist of the currently logged-in user.

Parameters:
query - An instance of class WorklistQuery describing the requested view on the worklist.
Returns:
An instance of Worklist making up the requested view on the current user's worklist.
Throws:
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getWorklist( org.eclipse.stardust.engine.api.query.WorklistQuery query)

activateNextActivityInstance

ActivityInstance activateNextActivityInstance(WorklistQuery query)
                                              throws WorkflowException
Activates the next activity instance from the given worklist query if any.

Parameters:
worklist - query.
Returns:
the ActivityInstance that was activated.
Throws:
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the current user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.activateNextActivityInstance( org.eclipse.stardust.engine.api.query.WorklistQuery query)

activateNextActivityInstance

ActivityInstance activateNextActivityInstance(long activityInstanceOID)
                                              throws WorkflowException
Activates the next activity instance after the specified one in the same process instance.

Parameters:
activityInstanceOID - the OID of the last completed activity instance.
Returns:
the ActivityInstance that was activated.
Throws:
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the current user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.activateNextActivityInstance( long activityInstanceOID)

activateNextActivityInstanceForProcessInstance

ActivityInstance activateNextActivityInstanceForProcessInstance(long processInstanceOID)
                                                                throws WorkflowException
Activates the next activity instance for the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance.
Returns:
the ActivityInstance that was activated.
Throws:
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the current user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.activateNextActivityInstanceForProcessInstance( long processInstanceOID)

setOutDataPath

void setOutDataPath(long processInstanceOID,
                    java.lang.String id,
                    java.lang.Object object)
                    throws WorkflowException
Sets an OUT data path on a process instance as specified in the corresponding process definition.

Parameters:
processInstanceOID - the OID of the process instance.
id - the ID of the data path as defined in the model.
object - the value to set on the data path.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID, if there is no data path with the specified id or if the underlying data is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if the object to be written represents an invalid value, most probably as of a type conflict in case of statically typed data. Instances of InvalidValueException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
setOutDataPaths(long, Map), WorkflowService.setOutDataPath( long processInstanceOID, java.lang.String id, java.lang.Object object)

setOutDataPaths

void setOutDataPaths(long processInstanceOID,
                     java.util.Map values)
                     throws WorkflowException
Sets multiple OUT data paths on a process instance as specified in the corresponding process definition.

Parameters:
processInstanceOID - the OID of the process instance.
values - A map of (id, value) pairs to be set, where every ID has to designate a valid data path as defined in the model.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID, if there is no data path with the specified id or if the underlying data is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidValueException - if one of the values to be written represents is invalid, most probably as of a type conflict in case of statically typed data. Instances of InvalidValueException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
setOutDataPath(long, String, Object), WorkflowService.setOutDataPaths( long processInstanceOID, java.util.Map values)

getInDataPath

java.lang.Object getInDataPath(long processInstanceOID,
                               java.lang.String id)
                               throws WorkflowException
Retrieves an IN data path on a process instance as specified in the corresponding process definition.

Parameters:
processInstanceOID - the OID of the process instance.
id - the ID of the data path as defined in the model.
Returns:
the value of the data path applied to the process instance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID, if there is no data path with the specified id or if the underlying data is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
getInDataPaths(long, Set), WorkflowService.getInDataPath( long processInstanceOID, java.lang.String id)

getInDataPaths

java.util.Map<java.lang.String,java.io.Serializable> getInDataPaths(long processInstanceOID,
                                                                    java.util.Set ids)
                                                                    throws WorkflowException
Retrieves multiple IN data paths from a process instance as specified in the corresponding process definition.

Parameters:
processInstanceOID - the OID of the process instance.
ids - the set of data path IDs designating the values to be retrieved. If null is passed, all IN data paths for the process instance are retrieved.
Returns:
the values of the data paths applied to the process instance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID, if there is no data path with the specified id or if the underlying data is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
getInDataPath(long, String), WorkflowService.getInDataPaths( long processInstanceOID, java.util.Set ids)

delegateToDefaultPerformer

ActivityInstance delegateToDefaultPerformer(long activityInstanceOID)
                                            throws WorkflowException
Delegates the specified activitiy instance to the default worklist of the corresponding activity.

Parameters:
activityInstanceOID - the OID of the activity instance.
Returns:
the ActivityInstance that was delegated.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.delegateToDefaultPerformer( long activityInstanceOID)

delegateToUser

ActivityInstance delegateToUser(long activityInstanceOID,
                                long userOID)
                                throws WorkflowException
Delegates the specified activity instance to a specific performer.

Parameters:
activityInstanceOID - the OID of the activity instance.
userOID - the OID of the user to which the activity instance will be delegated.
Returns:
the ActivityInstance that was delegated.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance or user with the specified OIDs. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the specified user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.delegateToUser( long activityInstanceOID, long userOID)

delegateToParticipant

ActivityInstance delegateToParticipant(long activityInstanceOID,
                                       java.lang.String performer)
                                       throws WorkflowException
Delegates the specified activity instance to a specific performer.

Parameters:
activityInstanceOID - the OID of the activity instance.
performer - the ID of the performer to which the activity instance will be delegated.
Returns:
the ActivityInstance that was delegated.
Throws:
org.eclipse.stardust.common.error.ConcurrencyException - if the same activity instance is being processed by another user. Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.delegateToParticipant( long activityInstanceOID, java.lang.String performer)

delegateToParticipant

ActivityInstance delegateToParticipant(long activityInstanceOID,
                                       ParticipantInfo participant)
                                       throws WorkflowException
Delegates the activity instance to the specified participant as follows:
  • if the participant is null, then delegates the activity to the default performer.
  • if the participant is an instance of a UserInfo, then delegates the activity to the specified user.
  • if the participant is an instance of a UserGroupInfo, then delegates the activity to the specified user group.
  • if the participant is an instance of a ModelParticipantInfo, then delegates the activity to the specified model participant.

Parameters:
activityInstanceOID - the OID of the activity instance.
participant - the participant ( model participant, user or user group) to which the activity instance will be delegated.
Returns:
the ActivityInstance that was delegated.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID or if the participant is not null and could not be resolved to an actual user user group or model participant. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the activity instance is already terminated or is currently processed by another user or the current user does not have the required permission or if the delegation target is not granted to execute the activity instance or if the activity instance is already terminated. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
IllegalOperationException - if the specified activity instance is a quality assurance instance QualityAssuranceState#IS_QUALITY_ASSURANCE and the specified user is the one who worked on the previous workflow instance Instances of IllegalOperationException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.delegateToParticipant( long activityInstanceOID, org.eclipse.stardust.engine.api.model.ParticipantInfo participant)

getActivityInstance

ActivityInstance getActivityInstance(long activityInstanceOID)
                                     throws WorkflowException
Retrieves the specified ActivityInstance.

Parameters:
activityInstanceOID - the OID of the activity instance.
Returns:
the ActivityInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getActivityInstance( long activityInstanceOID)

getProcessInstance

ProcessInstance getProcessInstance(long processInstanceOID)
                                   throws WorkflowException
Retrieves the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance.
Returns:
the ProcessInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getProcessInstance( long processInstanceOID)

getProcessResults

java.util.Map<java.lang.String,java.io.Serializable> getProcessResults(long processInstanceOID)
                                                                       throws WorkflowException
TODO

Parameters:
processInstanceOID - the OID of the process instance.
Returns:
TODO
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the process instance is not completed or the user does not have the permission to access this process. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getProcessResults( long processInstanceOID)

bindActivityEventHandler

ActivityInstance bindActivityEventHandler(long activityInstanceOID,
                                          EventHandlerBinding eventHandler)
                                          throws WorkflowException
Binds an event handler to the specified activity instance.

Parameters:
activityInstanceOID - the OID of the activity instance.
eventHandler - the specialized form of the event handler to bind.
Returns:
the ActivityInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
BindingException - in case of semantic binding errors. Instances of BindingException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - in case eventHandler is null. Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
getActivityInstanceEventHandler(long, java.lang.String), WorkflowService.bindActivityEventHandler( long activityInstanceOID, org.eclipse.stardust.engine.api.runtime.EventHandlerBinding eventHandler)

bindProcessEventHandler

ProcessInstance bindProcessEventHandler(long processInstanceOID,
                                        EventHandlerBinding eventHandler)
                                        throws WorkflowException
Binds an event handler to the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance.
eventHandler - the specialized form of the event handler to bind.
Returns:
the ProcessInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
BindingException - in case of semantic binding errors. Instances of BindingException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
getProcessInstanceEventHandler(long, java.lang.String), WorkflowService.bindProcessEventHandler( long processInstanceOID, org.eclipse.stardust.engine.api.runtime.EventHandlerBinding eventHandler)

bindActivityEventHandler

ActivityInstance bindActivityEventHandler(long activityInstanceOID,
                                          java.lang.String handler)
                                          throws WorkflowException
Binds an event handler to the specified activity instance.

Parameters:
activityInstanceOID - the OID of the activity instance.
handler - the ID of the event handler to bind.
Returns:
the ActivityInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
BindingException - in case of semantic binding errors. Instances of BindingException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.bindActivityEventHandler( long activityInstanceOID, java.lang.String handler)

bindProcessEventHandler

ProcessInstance bindProcessEventHandler(long processInstanceOID,
                                        java.lang.String handler)
                                        throws WorkflowException
Binds an event handler to the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance.
handler - the ID of the event handler to bind.
Returns:
the ProcessInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
BindingException - in case of semantic binding errors. Instances of BindingException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.bindProcessEventHandler( long processInstanceOID, java.lang.String handler)

unbindActivityEventHandler

ActivityInstance unbindActivityEventHandler(long activityInstanceOID,
                                            java.lang.String handler)
                                            throws WorkflowException
Unbinds an event handler from the specified activity instance.

Parameters:
activityInstanceOID - the OID of the activity instance.
handler - the ID of the event handler to unbind.
Returns:
the ActivityInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
BindingException - in case of semantic binding errors. Instances of BindingException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.unbindActivityEventHandler( long activityInstanceOID, java.lang.String handler)

unbindProcessEventHandler

ProcessInstance unbindProcessEventHandler(long processInstanceOID,
                                          java.lang.String handler)
                                          throws WorkflowException
Unbinds an event handler from the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance.
handler - the ID of the event handler to unbind.
Returns:
the ProcessInstance.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
BindingException - in case of semantic binding errors. Instances of BindingException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.unbindProcessEventHandler( long processInstanceOID, java.lang.String handler)

getActivityInstanceEventHandler

EventHandlerBinding getActivityInstanceEventHandler(long activityInstanceOID,
                                                    java.lang.String handler)
                                                    throws WorkflowException
Gets the binding state of an event handler for the specified activity instance.

Parameters:
activityInstanceOID - the OID of the activity instance.
handler - the ID of the event handler.
Returns:
the EventHandlerBinding.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getActivityInstanceEventHandler( long activityInstanceOID, java.lang.String handler)

getProcessInstanceEventHandler

EventHandlerBinding getProcessInstanceEventHandler(long processInstanceOID,
                                                   java.lang.String handler)
                                                   throws WorkflowException
Gets the binding state of an event handler for the specified process instance.

Parameters:
processInstanceOID - the OID of the process instance.
handler - the ID of the event handler.
Returns:
the EventHandlerBinding.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getProcessInstanceEventHandler( long processInstanceOID, java.lang.String handler)

getAdHocTransitionTargets

java.util.List<TransitionTarget> getAdHocTransitionTargets(long activityInstanceOid,
                                                           TransitionOptions options,
                                                           ScanDirection direction)
                                                           throws WorkflowException
Retrieves the possible targets for forward transitions starting from the specified activity instance.

Parameters:
activityInstanceOid - the oid of the activity instance from where the transition will be performed.
options - search options, if null then TransitionOptions.DEFAULT will be used.
direction - TODO
Returns:
A list of possible transition targets.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getAdHocTransitionTargets( long activityInstanceOid, org.eclipse.stardust.engine.api.runtime.TransitionOptions options, org.eclipse.stardust.engine.api.runtime.ScanDirection direction)

performAdHocTransition

ActivityInstance performAdHocTransition(long activityInstanceOid,
                                        TransitionTarget target,
                                        boolean complete)
                                        throws WorkflowException
Performs the transition from the specified activity instance to the specified target.

Parameters:
activityInstanceOid - the oid of the activity instance from where the transition will be performed.
target - the transition target.
complete - true if the activity instance specified should be completed, false if the activity should be aborted.
Returns:
the activity instance from which the transition was performed.
Throws:
IllegalOperationException - if the transition could not be performed because the specified TransitionTarget did not originate from the specified activity instance, or the activity instance was nce was already terminated or the process instance containing the activity instance has more than one active active activity instance. Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not allowed to perform the ad-hoc transition. Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no activity instance with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.performAdHocTransition( long activityInstanceOid, org.eclipse.stardust.engine.api.runtime.TransitionTarget target, boolean complete)

getStartableProcessDefinitions

java.util.List<ProcessDefinition> getStartableProcessDefinitions()
                                                                 throws WorkflowException
Retrieves the list of process definitions that can be started by the current user.

Returns:
a List with ProcessDefinition objects.
Throws:
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getStartableProcessDefinitions( )

getUser

User getUser()
             throws WorkflowException
Retrieves information on the current user.

Returns:
the current user.
Throws:
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getUser()

getPermissions

java.util.List<Permission> getPermissions()
                                          throws WorkflowException
Retrieves all permissions the current user has on this service.

Returns:
a list of permission ids.
Throws:
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.getPermissions()

setProcessInstanceAttributes

void setProcessInstanceAttributes(ProcessInstanceAttributes attributes)
                                  throws WorkflowException
Sets specific attributes of a process instance. At the moment attributes has to be bound to a scope process instance.

Note: After a ProcessInstanceAttributes instance is applied to this method it is discouraged to use this same instance again. Any new note which has been added by the first use will be added again. In order to add new notes to a certain process instance a fresh ProcessInstance has to be retrieved (e.g. by WorkflowService#getProcessInstance(long)). Get a current copy of ProcessInstanceAttributes by ProcessInstance#getAttributes().

Parameters:
attributes - the container of attributes.
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no process instance with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
PublicException - if the process instance is no scope process instance. Instances of PublicException will be wrapped inside WorkflowException.
InvalidArgumentException - if attributes is null. Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.setProcessInstanceAttributes( org.eclipse.stardust.engine.api.dto.ProcessInstanceAttributes attributes)

setActivityInstanceAttributes

void setActivityInstanceAttributes(ActivityInstanceAttributes attributes)
                                   throws WorkflowException
Sets attributes for an activity instance

Parameters:
attributes - - the attributes to set
Throws:
org.eclipse.stardust.common.error.ObjectNotFoundException - - if the activity instance specified by ActivityInstanceAttributes#getActivityInstanceOid() could no be found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - - when a result is set (ActivityInstanceAttributes#getQualityAssuranceResult() and the codes list(QualityAssuranceResult#getQualityAssuranceCodes( ) contains a null element Instances of InvalidArgumentException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - - when the specified quality assurance ActivityInstanceAttributes#getActivityInstanceOid( ) instance is marked as ResultState#PASS_WITH_CORRECTION or ResultState#FAILED, the corresponding activity for this activity instance supplies error codes IActivity#getQualityAssuranceCodes( ) and no error code was supplied Instances of InvalidArgumentException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.setActivityInstanceAttributes( org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes attributes)

writeLogEntry

void writeLogEntry(LogType logType,
                   ContextKind contextType,
                   long contextOid,
                   java.lang.String message,
                   java.lang.Throwable throwable)
                   throws WorkflowException
Logs an audit trail event of type LogCode.EXTERNAL.

Parameters:
logType - Set the type of log ( info, warn, error etc.). Whereas the Unknown type is mapped to a warning.
contextType - Set the context scope of the event
contextOid - Oid of the runtime object ( only used if context type is set to ProcessInstance or ActivityInstance)
message - any message that should be logged
throwable - any exception (or null) that should be appended to the message
Throws:
ObjectNotFoundException - if there is no runtime object with the specified OID
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.writeLogEntry( org.eclipse.stardust.engine.api.runtime.LogType logType, org.eclipse.stardust.engine.api.dto.ContextKind contextType, long contextOid, java.lang.String message, java.lang.Throwable throwable)

execute

java.io.Serializable execute(ServiceCommand serviceCmd)
                             throws WorkflowException
Executes a ServiceCommand in a single engine transaction. If the service command implements Configurable, the following option may be provided:
  • "autoFlush" - automatically flushes the audit trail changes after every service call. The value must be a Boolean object. The default value is Boolean.FALSE.

Parameters:
serviceCmd - the ServiceCommand to be executed.
Returns:
the result of the execution. May be null if the command has no result.
Throws:
org.eclipse.stardust.common.error.ServiceCommandException - that encapsulates any exception thrown during the execution of the command. Instances of ServiceCommandException will be wrapped inside WorkflowException.
WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions
See Also:
WorkflowService.execute( org.eclipse.stardust.engine.core.runtime.command.ServiceCommand serviceCmd)

login

void login(java.lang.String userId,
           java.lang.String password)
           throws WorkflowException
Throws:
WorkflowException

login

void login(java.lang.String userId,
           java.lang.String password,
           java.util.Map properties)
           throws WorkflowException
Throws:
WorkflowException

logout

void logout()
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2014 SunGard CSA LLC. All Rights Reserved.