|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface RemoteWorkflowService
The WorkflowService provides all functionality for workflow operations in a CARNOT runtime environment.
This includes:
| 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,
String context,
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,
String context,
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,
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,
String handler)
Binds an event handler to the specified process instance. |
ActivityInstance |
complete(long activityInstanceOID,
String context,
Map outData)
Completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user. |
ActivityCompletionLog |
complete(long activityInstanceOID,
String context,
Map outData,
int flags)
Completes the interactive activity instance identified by the activityInstanceOID on the behalf of the currently logged-in user. |
org.eclipse.stardust.engine.api.runtime.BusinessObject |
createBusinessObjectInstance(String qualifiedBusinessObjectId,
Object initialValue)
Creates a new business object instance if it does not exist. |
ProcessInstance |
createCase(String name,
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,
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. |
void |
deleteBusinessObjectInstance(String qualifiedBusinessObjectId,
Object primaryKey)
Deletes a business object instance. |
Serializable |
execute(ServiceCommand serviceCmd)
Executes a ServiceCommand in a single engine transaction. |
ActivityInstance |
getActivityInstance(long activityInstanceOID)
Retrieves the specified ActivityInstance. |
EventHandlerBinding |
getActivityInstanceEventHandler(long activityInstanceOID,
String handler)
Gets the binding state of an event handler for the specified activity instance. |
List<TransitionTarget> |
getAdHocTransitionTargets(long activityInstanceOid,
TransitionOptions options,
ScanDirection direction)
Retrieves the possible targets for forward transitions starting from the specified activity instance. |
Object |
getInDataPath(long processInstanceOID,
String id)
Retrieves an IN data path on a process instance as specified in the corresponding process definition. |
Map<String,Serializable> |
getInDataPaths(long processInstanceOID,
Set ids)
Retrieves multiple IN data paths from a process instance as specified in the corresponding process definition. |
Serializable |
getInDataValue(long activityInstanceOID,
String context,
String id)
Retrieves all evaluated IN data mappings that match the provided application context for the specified activity. |
Map<String,Serializable> |
getInDataValues(long activityInstanceOID,
String context,
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. |
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,
String handler)
Gets the binding state of an event handler for the specified process instance. |
Map<String,Serializable> |
getProcessResults(long processInstanceOID)
Process instances can declare or implement process interfaces. |
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,
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(String userId,
String password)
|
void |
login(String userId,
String password,
Map properties)
|
void |
logout()
|
ProcessInstance |
mergeCases(long targetCaseOid,
long[] sourceCaseOids,
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)
Deprecated. replaced with performAdHocTransition(TransitionTarget, boolean) |
TransitionReport |
performAdHocTransition(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,
String id,
Object object)
Sets an OUT data path on a process instance as specified in the corresponding process definition. |
void |
setOutDataPaths(long processInstanceOID,
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,
String spawnProcessID,
boolean copyData,
Map data,
boolean abortProcessInstance,
String comment)
Deprecated. use spawnPeerProcessInstance(long, String, SpawnOptions) |
ProcessInstance |
spawnPeerProcessInstance(long processInstanceOid,
String spawnProcessID,
SpawnOptions options)
Spawns a new root process and creates a link of type PredefinedProcessInstanceLinkTypes.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,
String spawnProcessID,
boolean copyData,
Map data)
Spawns a process as subprocess of the specified process instance. |
List<ProcessInstance> |
spawnSubprocessInstances(long parentProcessInstanceOid,
List subprocessSpawnInfo)
Spawns multiple processes as subprocesses of the specified process instance. |
ProcessInstance |
startProcess(String id,
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. |
ProcessInstance |
startProcess(String id,
org.eclipse.stardust.engine.api.runtime.StartOptions options)
|
ActivityInstance |
suspend(long activityInstanceOID,
ContextData outData)
Suspends the specified activity instance. |
ActivityInstance |
suspendToDefaultPerformer(long activityInstanceOID)
Suspends the specified activity instance. |
ActivityInstance |
suspendToDefaultPerformer(long activityInstanceOID,
String context,
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,
String participant)
Suspends the specified activity instance. |
ActivityInstance |
suspendToParticipant(long activityInstanceOID,
String participant,
String context,
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,
String context,
Map outData)
Suspends the specified activity instance. |
ActivityInstance |
suspendToUser(long activityInstanceOID,
String context,
Map outData)
Suspends the specified activity instance. |
ActivityInstance |
unbindActivityEventHandler(long activityInstanceOID,
String handler)
Unbinds an event handler from the specified activity instance. |
ProcessInstance |
unbindProcessEventHandler(long processInstanceOID,
String handler)
Unbinds an event handler from the specified process instance. |
org.eclipse.stardust.engine.api.runtime.BusinessObject |
updateBusinessObjectInstance(String qualifiedBusinessObjectId,
Object newValue)
Updates the value of a business object instance. |
void |
writeLogEntry(LogType logType,
ContextKind contextType,
long contextOid,
String message,
Throwable throwable)
Logs an audit trail event of type LogCode.EXTERNAL. |
| Methods inherited from interface javax.ejb.EJBObject |
|---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
| Method Detail |
|---|
ActivityInstance activate(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID.
Activating means:
State changes:
activityInstanceOID - the OID of the activity to be activated.
ActivityInstance that was
activated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionactivateAndComplete(long, java.lang.String, java.util.Map),
WorkflowService.activate(
long activityInstanceOID)
ActivityInstance complete(long activityInstanceOID,
String context,
Map outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID on the behalf of the currently logged-in user.
State Changes:
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.
ActivityInstance that was
completed.
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
ActivityInstanceAttributes has been set before.
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionactivateAndComplete(long, String, java.util.Map),
complete(long, String, java.util.Map, int),
setActivityInstanceAttributes(
org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes),
WorkflowService.complete(
long activityInstanceOID, java.lang.String context, java.util.Map outData)
ActivityCompletionLog complete(long activityInstanceOID,
String context,
Map outData,
int flags)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID on the behalf of the currently logged-in user.
State Changes:
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
WorkflowService.FLAG_ACTIVATE_NEXT_ACTIVITY_INSTANCE.
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
ActivityInstanceAttributes has been set before.
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptioncomplete(long, String, java.util.Map),
activateAndComplete(long, String, java.util.Map),
setActivityInstanceAttributes(
org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes),
WorkflowService.complete(
long activityInstanceOID, java.lang.String context, java.util.Map outData, int flags)
ActivityInstance activateAndComplete(long activityInstanceOID,
String context,
Map outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
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.
ActivityInstance that was completed.
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
ActivityInstanceAttributes has been set before.
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionactivate(long),
complete(long, String, java.util.Map),
activateAndComplete(long, String, java.util.Map, int),
setActivityInstanceAttributes(
org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes),
WorkflowService.activateAndComplete(
long activityInstanceOID, java.lang.String context, java.util.Map outData)
ActivityCompletionLog activateAndComplete(long activityInstanceOID,
String context,
Map outData,
int flags)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
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
WorkflowService.FLAG_ACTIVATE_NEXT_ACTIVITY_INSTANCE.
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
ActivityInstanceAttributes has been set before.
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionactivateAndComplete(long, String, java.util.Map),
activate(long),
complete(long, String, java.util.Map),
setActivityInstanceAttributes(
org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes),
WorkflowService.activateAndComplete(
long activityInstanceOID, java.lang.String context, java.util.Map outData, int flags)
Serializable getInDataValue(long activityInstanceOID,
String context,
String id)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptiongetInDataValues(long, String, java.util.Set),
WorkflowService.getInDataValue(
long activityInstanceOID, java.lang.String context, java.lang.String id)
Map<String,Serializable> getInDataValues(long activityInstanceOID,
String context,
Set ids)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
Serializable.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptiongetInDataValue(long, String, String),
WorkflowService.getInDataValues(
long activityInstanceOID, java.lang.String context, java.util.Set ids)
ActivityInstance suspend(long activityInstanceOID,
ContextData outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
activityInstanceOID - the OID of the activity to be suspended.outData - the context data containing values of out access points to be stored.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToDefaultPerformer(long, String, java.util.Map),
WorkflowService.suspend(
long activityInstanceOID, org.eclipse.stardust.engine.api.model.ContextData outData)
ActivityInstance suspendToDefaultPerformer(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
activityInstanceOID - the OID of the activity to be suspended.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToDefaultPerformer(long, String, java.util.Map),
WorkflowService.suspendToDefaultPerformer(
long activityInstanceOID)
ActivityInstance suspendToDefaultPerformer(long activityInstanceOID,
String context,
Map outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
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.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToDefaultPerformer(long),
WorkflowService.suspendToDefaultPerformer(
long activityInstanceOID, java.lang.String context, java.util.Map outData)
ActivityInstance suspendToUser(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
activityInstanceOID - the OID of the activity to be suspended.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToUser(long, String, java.util.Map),
WorkflowService.suspendToUser(
long activityInstanceOID)
ActivityInstance suspendToUser(long activityInstanceOID,
String context,
Map outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
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.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToUser(long),
WorkflowService.suspendToUser(
long activityInstanceOID, java.lang.String context, java.util.Map outData)
ActivityInstance suspendToUser(long activityInstanceOID,
long userOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
activityInstanceOID - the OID of the activity to be suspended.userOID - the OID of the user.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToUser(long, long, String, java.util.Map),
WorkflowService.suspendToUser(
long activityInstanceOID, long userOID)
ActivityInstance suspendToUser(long activityInstanceOID,
long userOID,
String context,
Map outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
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.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToUser(long, long),
WorkflowService.suspendToUser(
long activityInstanceOID, long userOID, java.lang.String context, java.util.Map
outData)
ActivityInstance suspendToParticipant(long activityInstanceOID,
String participant)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
activityInstanceOID - the OID of the activity to be suspended.participant - the ID of the performer.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToParticipant(long, String, String, java.util.Map),
WorkflowService.suspendToParticipant(
long activityInstanceOID, java.lang.String participant)
ActivityInstance suspendToParticipant(long activityInstanceOID,
String participant,
String context,
Map outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
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.
ActivityInstance that was suspended.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsuspendToParticipant(long, String),
WorkflowService.suspendToParticipant(
long activityInstanceOID, java.lang.String participant, java.lang.String context,
java.util.Map outData)
ActivityInstance suspendToParticipant(long activityInstanceOID,
ParticipantInfo participant,
ContextData outData)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
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.
ActivityInstance that was suspended.
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 instance
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.suspendToParticipant(
long activityInstanceOID, org.eclipse.stardust.engine.api.model.ParticipantInfo
participant, org.eclipse.stardust.engine.api.model.ContextData outData)
ActivityInstance hibernate(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity to be hibernated.
ActivityInstance that was hibernated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.hibernate(
long activityInstanceOID)
ProcessInstance startProcess(String id,
Map data,
boolean synchronously)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
ID using the provided data
and returns the OID of the newly created process instance.
State changes:
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 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.
ProcessInstance that was started.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.startProcess(
java.lang.String id, java.util.Map data, boolean synchronously)
ProcessInstance startProcess(String id,
org.eclipse.stardust.engine.api.runtime.StartOptions options)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.startProcess(
java.lang.String id, org.eclipse.stardust.engine.api.runtime.StartOptions options)
ProcessInstance spawnSubprocessInstance(long parentProcessInstanceOid,
String spawnProcessID,
boolean copyData,
Map data)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
ProcessInstance that was spawned.
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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.spawnSubprocessInstance(
long parentProcessInstanceOid, java.lang.String spawnProcessID, boolean copyData,
java.util.Map data)
List<ProcessInstance> spawnSubprocessInstances(long parentProcessInstanceOid,
List subprocessSpawnInfo)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
parentProcessInstanceOid - The oid of the process to spawn from.subprocessSpawnInfo - A List of SubprocessSpawnInfo holding information about the subprocesses to be
spawned.
ProcessInstance that were
spawned.
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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.spawnSubprocessInstances(
long parentProcessInstanceOid, java.util.List subprocessSpawnInfo)
ProcessInstance spawnPeerProcessInstance(long processInstanceOid,
String spawnProcessID,
boolean copyData,
Map data,
boolean abortProcessInstance,
String comment)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
spawnPeerProcessInstance(long, String, SpawnOptions)
PredefinedProcessInstanceLinkTypes.SWITCH to the specified process instance.
Please note that currently the specified process instance has to be aborted by
setting abortProcessInstance to true.
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.
ProcessInstance that was spawned.
IllegalOperationException - if the process instance is terminated or not a root process instance. if
the process instance and the process definition are from different
models. if the process instances process definition is the same as the
specified process definition.
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.InvalidArgumentException - if abortProcessInstance is false (currently not
implemented).
Instances of InvalidArgumentException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if a lock on process instances cannot be obtained.
Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.spawnPeerProcessInstance(
long processInstanceOid, java.lang.String spawnProcessID, boolean copyData,
java.util.Map data, boolean abortProcessInstance, java.lang.String comment)
ProcessInstance spawnPeerProcessInstance(long processInstanceOid,
String spawnProcessID,
SpawnOptions options)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
PredefinedProcessInstanceLinkTypes.SWITCH to the specified process instance.
Please note that currently the specified process instance has to be aborted by
setting abortProcessInstance to true.
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.
ProcessInstance that was spawned.
IllegalOperationException - if the process instance is terminated or not a root process instance. if
the process instance and the process definition are from different
models. if the process instances process definition is the same as the
specified process definition.
Instances of IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.InvalidArgumentException - if abortProcessInstance is false (currently not
implemented).
Instances of InvalidArgumentException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.ConcurrencyException - if a lock on process instances cannot be obtained.
Instances of ConcurrencyException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.spawnPeerProcessInstance(
long processInstanceOid, java.lang.String spawnProcessID,
org.eclipse.stardust.engine.api.runtime.SpawnOptions options)
ProcessInstance createCase(String name,
String description,
long[] memberOids)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.InvalidArgumentException - if memberOids is empty or null.
Instances of InvalidArgumentException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionProcessInstance.isCaseProcessInstance(),
WorkflowService.createCase(
java.lang.String name, java.lang.String description, long[] memberOids)
ProcessInstance joinCase(long caseOid,
long[] memberOids)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
caseOid - The oid of the case process instance.memberOids - The oids of the process instances which should become members of the case.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.joinCase(
long caseOid, long[] memberOids)
ProcessInstance leaveCase(long caseOid,
long[] memberOids)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
caseOid - The oid of the case process instance.memberOids - The oids of the process instances which should be removed from the case.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.AccessForbiddenException - if the user is not the owner of the case.
Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.leaveCase(
long caseOid, long[] memberOids)
ProcessInstance mergeCases(long targetCaseOid,
long[] sourceCaseOids,
String comment)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
targetCaseOid - The target case process instancesourceCaseOids - The source case process instances.comment - Allows to specify a comment
org.eclipse.stardust.common.error.ObjectNotFoundException - if one of the process instances referenced by sourceCaseOids
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 active. if sourceCaseOids contains a
process instance which equals the targetCaseOid. if
targetCaseOid is not a case process instance.
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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.mergeCases(
long targetCaseOid, long[] sourceCaseOids, java.lang.String comment)
ProcessInstance delegateCase(long caseOid,
ParticipantInfo participant)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
caseOid - The case process instance to delegate.participant - The targetParticipant.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.delegateCase(
long caseOid, org.eclipse.stardust.engine.api.model.ParticipantInfo participant)
ProcessInstance joinProcessInstance(long processInstanceOid,
long targetProcessInstanceOid,
String comment)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
org.eclipse.stardust.common.error.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.IllegalOperationException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.joinProcessInstance(
long processInstanceOid, long targetProcessInstanceOid, java.lang.String comment)
ActivityInstance abortActivityInstance(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
abortActivityInstance(long, AbortScope) using AbortScope.RootHierarchy
.
Note: Abort is performed asynchronously.
State changes
activityInstanceOID - The OID of the activity instance to be aborted.
ActivityInstance that was aborted.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionAdministrationService.abortProcessInstance(
long),
abortActivityInstance(long,
org.eclipse.stardust.engine.core.runtime.beans.AbortScope),
WorkflowService.abortActivityInstance(
long activityInstanceOID)
ActivityInstance abortActivityInstance(long activityInstanceOid,
AbortScope abortScope)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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
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. AbortScope.SubHierarchy then the specified
activity instance is set to state
ActivityInstanceState.Aborting. The abort itself is performed
asynchronously. If activity instance is a subprocess then the complete
subprocess hierarchy will be aborted. 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.
ActivityInstance that was aborted.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionAdministrationService.abortProcessInstance(
long),
abortActivityInstance(long),
WorkflowService.abortActivityInstance(
long activityInstanceOid, org.eclipse.stardust.engine.core.runtime.beans.AbortScope
abortScope)
ProcessInstance abortProcessInstance(long processInstanceOid,
AbortScope abortScope)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
State changes:
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.
ProcessInstance that was aborted.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.abortProcessInstance(
long processInstanceOid, org.eclipse.stardust.engine.core.runtime.beans.AbortScope
abortScope)
DeployedModel getModel()
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no active model.
Instances of ObjectNotFoundException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getModel()
Worklist getWorklist(WorklistQuery query)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
query - An instance of class
WorklistQuery
describing the requested view on the worklist.
Worklist making up the requested view on the current user's worklist.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getWorklist(
org.eclipse.stardust.engine.api.query.WorklistQuery query)
ActivityInstance activateNextActivityInstance(WorklistQuery query)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
query - worklist query.
ActivityInstance that was activated.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.activateNextActivityInstance(
org.eclipse.stardust.engine.api.query.WorklistQuery query)
ActivityInstance activateNextActivityInstance(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the last completed activity instance.
ActivityInstance that was activated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.activateNextActivityInstance(
long activityInstanceOID)
ActivityInstance activateNextActivityInstanceForProcessInstance(long processInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.
ActivityInstance that was activated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.activateNextActivityInstanceForProcessInstance(
long processInstanceOID)
void setOutDataPath(long processInstanceOID,
String id,
Object object)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsetOutDataPaths(long, java.util.Map),
WorkflowService.setOutDataPath(
long processInstanceOID, java.lang.String id, java.lang.Object object)
void setOutDataPaths(long processInstanceOID,
Map values)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionsetOutDataPath(long, String, Object),
WorkflowService.setOutDataPaths(
long processInstanceOID, java.util.Map values)
Object getInDataPath(long processInstanceOID,
String id)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.id - the ID of the data path as defined in the model.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptiongetInDataPaths(long, java.util.Set),
WorkflowService.getInDataPath(
long processInstanceOID, java.lang.String id)
Map<String,Serializable> getInDataPaths(long processInstanceOID,
Set ids)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptiongetInDataPath(long, String),
WorkflowService.getInDataPaths(
long processInstanceOID, java.util.Set ids)
ActivityInstance delegateToDefaultPerformer(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.
ActivityInstance that was delegated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.delegateToDefaultPerformer(
long activityInstanceOID)
ActivityInstance delegateToUser(long activityInstanceOID,
long userOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.userOID - the OID of the user to which the activity instance will be delegated.
ActivityInstance that was delegated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.delegateToUser(
long activityInstanceOID, long userOID)
ActivityInstance delegateToParticipant(long activityInstanceOID,
String performer)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.performer - the ID of the performer to which the activity instance will be delegated.
ActivityInstance that was delegated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.delegateToParticipant(
long activityInstanceOID, java.lang.String performer)
ActivityInstance delegateToParticipant(long activityInstanceOID,
ParticipantInfo participant)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.participant - the participant (model participant, user or user group) to which the
activity instance will be delegated.
ActivityInstance that was delegated.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.delegateToParticipant(
long activityInstanceOID, org.eclipse.stardust.engine.api.model.ParticipantInfo
participant)
ActivityInstance getActivityInstance(long activityInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.
ActivityInstance.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getActivityInstance(
long activityInstanceOID)
ProcessInstance getProcessInstance(long processInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.
ProcessInstance.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getProcessInstance(
long processInstanceOID)
Map<String,Serializable> getProcessResults(long processInstanceOID)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.
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, is no scope process instance or
the user does not have the permission to access this process.
Instances of AccessForbiddenException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getProcessResults(
long processInstanceOID)
ActivityInstance bindActivityEventHandler(long activityInstanceOID,
EventHandlerBinding eventHandler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.eventHandler - the specialized form of the event handler to bind.
ActivityInstance.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptiongetActivityInstanceEventHandler(long, java.lang.String),
WorkflowService.bindActivityEventHandler(
long activityInstanceOID, org.eclipse.stardust.engine.api.runtime.EventHandlerBinding
eventHandler)
ProcessInstance bindProcessEventHandler(long processInstanceOID,
EventHandlerBinding eventHandler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.eventHandler - the specialized form of the event handler to bind.
ProcessInstance.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptiongetProcessInstanceEventHandler(long, java.lang.String),
WorkflowService.bindProcessEventHandler(
long processInstanceOID, org.eclipse.stardust.engine.api.runtime.EventHandlerBinding
eventHandler)
ActivityInstance bindActivityEventHandler(long activityInstanceOID,
String handler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.handler - the ID of the event handler to bind.
ActivityInstance.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.bindActivityEventHandler(
long activityInstanceOID, java.lang.String handler)
ProcessInstance bindProcessEventHandler(long processInstanceOID,
String handler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.handler - the ID of the event handler to bind.
ProcessInstance.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.bindProcessEventHandler(
long processInstanceOID, java.lang.String handler)
ActivityInstance unbindActivityEventHandler(long activityInstanceOID,
String handler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.handler - the ID of the event handler to unbind.
ActivityInstance.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.unbindActivityEventHandler(
long activityInstanceOID, java.lang.String handler)
ProcessInstance unbindProcessEventHandler(long processInstanceOID,
String handler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.handler - the ID of the event handler to unbind.
ProcessInstance.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.unbindProcessEventHandler(
long processInstanceOID, java.lang.String handler)
EventHandlerBinding getActivityInstanceEventHandler(long activityInstanceOID,
String handler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
activityInstanceOID - the OID of the activity instance.handler - the ID of the event handler.
EventHandlerBinding.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getActivityInstanceEventHandler(
long activityInstanceOID, java.lang.String handler)
EventHandlerBinding getProcessInstanceEventHandler(long processInstanceOID,
String handler)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
processInstanceOID - the OID of the process instance.handler - the ID of the event handler.
EventHandlerBinding.
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getProcessInstanceEventHandler(
long processInstanceOID, java.lang.String handler)
List<TransitionTarget> getAdHocTransitionTargets(long activityInstanceOid,
TransitionOptions options,
ScanDirection direction)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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
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.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getAdHocTransitionTargets(
long activityInstanceOid, org.eclipse.stardust.engine.api.runtime.TransitionOptions
options, org.eclipse.stardust.engine.api.runtime.ScanDirection direction)
ActivityInstance performAdHocTransition(long activityInstanceOid,
TransitionTarget target,
boolean complete)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
performAdHocTransition(TransitionTarget, boolean)
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.
IllegalOperationException - if the transition could not be performed because the specified
TransitionTarget did not originate from the specified activity instance,
or the process instance containing the activity instance has more than
one 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, or
the activity instance was 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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.performAdHocTransition(
long activityInstanceOid, org.eclipse.stardust.engine.api.runtime.TransitionTarget
target, boolean complete)
TransitionReport performAdHocTransition(TransitionTarget target,
boolean complete)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
target - the transition target.complete - true if the activity instance specified should be completed, false if the
activity should be aborted.
IllegalOperationException - if the transition could not be performed because the specified
TransitionTarget did not originate from the specified activity instance,
or the process instance containing the activity instance has more than
one 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, or
the activity instance was 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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.performAdHocTransition(
org.eclipse.stardust.engine.api.runtime.TransitionTarget target, boolean complete)
List<ProcessDefinition> getStartableProcessDefinitions()
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
ProcessDefinition objects.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getStartableProcessDefinitions(
)
User getUser()
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getUser()
List<Permission> getPermissions()
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.getPermissions()
void setProcessInstanceAttributes(ProcessInstanceAttributes attributes)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
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 getProcessInstance(long)). Get a current copy of
ProcessInstanceAttributes by
ProcessInstance.getAttributes().
attributes - the container of attributes.
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.PublicException - if the process instance is no scope process instance.
Instances of PublicException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.InvalidArgumentException - if attributes is null.
Instances of InvalidArgumentException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.setProcessInstanceAttributes(
org.eclipse.stardust.engine.api.dto.ProcessInstanceAttributes attributes)
void setActivityInstanceAttributes(ActivityInstanceAttributes attributes)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
attributes - - the attributes to set
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.setActivityInstanceAttributes(
org.eclipse.stardust.engine.api.dto.ActivityInstanceAttributes attributes)
void writeLogEntry(LogType logType,
ContextKind contextType,
long contextOid,
String message,
Throwable throwable)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
LogCode.EXTERNAL.
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 eventcontextOid - Oid of the runtime object (only used if context type is set to
ProcessInstance or ActivityInstance)message - any message that should be loggedthrowable - any exception (or null) that should be appended to the message
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no runtime object with the specified OID
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.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)
Serializable execute(ServiceCommand serviceCmd)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
ServiceCommand in a single engine transaction.
If the service command implements
Configurable
, the following option may be provided:
Boolean
object. The default value is
Boolean.FALSE.
serviceCmd - the ServiceCommand to be executed.
null if the command has no
result.
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.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.execute(
org.eclipse.stardust.engine.core.runtime.command.ServiceCommand serviceCmd)
org.eclipse.stardust.engine.api.runtime.BusinessObject createBusinessObjectInstance(String qualifiedBusinessObjectId,
Object initialValue)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
qualifiedBusinessObjectId - the qualified id of the business object.initialValue - the initial value of the business instance (can be null).
org.eclipse.stardust.common.error.ObjectExistsException - if BO already exists.
Instances of ObjectExistsException will be wrapped inside WorkflowException.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.createBusinessObjectInstance(
java.lang.String qualifiedBusinessObjectId, java.lang.Object initialValue)
org.eclipse.stardust.engine.api.runtime.BusinessObject updateBusinessObjectInstance(String qualifiedBusinessObjectId,
Object newValue)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
qualifiedBusinessObjectId - the qualified id of the business object.newValue - the new value of the business instance (can be null).
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.updateBusinessObjectInstance(
java.lang.String qualifiedBusinessObjectId, java.lang.Object newValue)
void deleteBusinessObjectInstance(String qualifiedBusinessObjectId,
Object primaryKey)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
qualifiedBusinessObjectId - the qualified id of the business object.primaryKey - the primary key identifying the instance to be deleted.
org.eclipse.stardust.common.error.WorkflowException - as a wrapper for
org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions
RemoteExceptionWorkflowService.deleteBusinessObjectInstance(
java.lang.String qualifiedBusinessObjectId, java.lang.Object primaryKey)
void login(String userId,
String password)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
org.eclipse.stardust.common.error.WorkflowException
RemoteException
void login(String userId,
String password,
Map properties)
throws org.eclipse.stardust.common.error.WorkflowException,
RemoteException
org.eclipse.stardust.common.error.WorkflowException
RemoteException
void logout()
throws RemoteException
RemoteException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||