org.eclipse.stardust.engine.api.ws
Interface IWorkflowService


public interface IWorkflowService

The WorkflowService provides all functionality for workflow operations in a CARNOT runtime environment. This includes: starting and aborting process instances, activating, completing, suspending and aborting activities, binding and unbinding event handlers, delegating activities, and accessing workflow data. This class was generated by Apache CXF 2.6.1 2016-02-25T15:28:24.639+01:00 Generated source version: 2.6.1


Method Summary
 ActivityInstanceXto abortActivity(long activityOid, AbortScopeXto abortScope)
          Aborts the specified activity instance, effectively aborting the whole process instance hierarchy this activity instance belongs to.
 ProcessInstanceXto abortProcessInstance(long oid, AbortScopeXto abortScope)
          Aborts the specified process instance.
 ActivityInstanceXto activateActivity(long activityOid)
          Activates the interactive activity instance identified by the activityOID.
 ParametersXto activateActivityAndGetInData(long activityOid, String context)
          Activates the interactive activity instance identified by the activityOID and retrieves all evaluated IN data mappings that match the provided interaction context for the specified activity.
 ActivityInstanceXto activateNextActivity(Long activityOid, WorklistQueryXto worklistQuery)
          Activates the next activity instance after the specified one in the same process instance.
 ActivityInstanceXto activateNextActivityForProcess(long processOid)
          Activates the next activity instance for the specified process instance.
 ActivityInstanceXto completeActivity(long activityOid, String context, ParametersXto outDataValues, Boolean activate)
          Completes the interactive activity instance identified by the activityOid on the behalf of the currently logged-in user.
 ActivityInstancesXto completeActivityAndActivateNext(long activityOid, String context, ParametersXto outDataValues, Boolean activate)
          Completes the interactive activity instance identified by the activityOid on the behalf of the currently logged-in user and activates the next activity instance after the specified one in the same process instance.
 ActivityEventBindingXto createActivityEventBinding(long activityOid, ActivityEventBindingXto bindingInfo)
          Binds an event handler to the specified activity instance.
 BusinessObjectXto createBusinessObjectInstance(String qualifiedBusinessObjectId, ParameterXto initialValue)
          Creates a new business object instance if it does not exist.
 ProcessInstanceXto createCase(String name, String description, OidListXto memberOids)
          Creates a case process instance which groups the specified members as subprocesses.
 ProcessEventBindingXto createProcessEventBinding(long processOid, ProcessEventBindingXto bindingInfo)
          Binds an event handler to the specified process instance.
 ActivityInstanceXto delegateActivity(long activityOid, ParticipantInfoBaseXto participant)
          Delegates the activity instance to the specified participant as follows: If the participant is a DefaultPerformer, the activity is delegated to the default performer.
 ProcessInstanceXto delegateCase(long caseOid, ParticipantInfoXto participantInfo)
          Delegates the case process instance to the specified participant.
 void deleteBusinessObjectInstance(String qualifiedBusinessObjectId, ParameterXto primaryKey)
          Deletes a business object instance.
 WorklistXto findWorklist(WorklistQueryXto worklistQuery)
          Retrieves (parts of) the worklist of the current logged in user satisfying the criteria specified in the provided query.
 ActivityInstanceXto getActivity(long activityOid)
          Retrieves the specified activity instance.
 ActivityEventBindingXto getActivityEventBinding(long activityOid, String eventHandlerId)
          Gets the binding state of an event handler for the specified activity instance.
 ParametersXto getActivityInData(long activityOid, String context, org.eclipse.stardust.engine.api.ws.GetActivityInData.DataIdsXto dataIds)
          Retrieves all evaluated IN data mappings that match the provided interaction context for the specified activity.
 PermissionsXto getPermissions()
          Retrieves all permissions the current user has on this service.
 ProcessInstanceXto getProcess(long processOid)
          Retrieves the specified process instance.
 ProcessEventBindingXto getProcessEventBinding(long processOid, String eventHandlerId)
          Gets the binding state of an event handler for the specified process instance.
 InstancePropertiesXto getProcessProperties(long processInstanceOid, org.eclipse.stardust.engine.api.ws.GetProcessProperties.PropertyIdsXto propertyIds)
          Retrieves multiple IN data paths from a process instance as specified in the corresponding process definition.
 UserXto getSessionUser()
          Retrieves information on the current user.
 ProcessDefinitionsXto getStartableProcessDefinitions()
          Retrieves the list of process definitions that can be started by the current user.
 ActivityInstanceXto hibernateActivity(long activityOid)
          Change the state of the specified activity instance to HIBERNATED.
 ProcessInstanceXto joinCase(long caseOid, OidListXto memberOids)
          Adds the process instances referenced by the specified memberOids to the specified case process instance.
 ProcessInstanceXto joinProcessInstance(long processInstanceOid, long targetProcessInstanceOid, String comment)
          Aborts the specified process instance and joins the data into the specified target process instance.
 ProcessInstanceXto leaveCase(long caseOid, OidListXto memberOids)
          Removes the process instances referenced by the specified memberOids from the specified case process instance.
 ProcessInstanceXto mergeCases(long targetCaseOid, OidListXto 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.
 ActivityEventBindingXto removeActivityEventBinding(long activityOid, String eventHandlerId)
          Unbinds an event handler from the specified activity instance.
 ProcessEventBindingXto removeProcessEventBinding(long processOid, String eventHandlerId)
          Unbinds an event handler from the specified process instance.
 void setProcessProperties(long processInstanceOid, InstancePropertiesXto processProperties)
          Sets multiple OUT data paths on a process instance as specified in the corresponding process definition.
 ProcessInstanceXto spawnPeerProcessInstance(long processInstanceOid, String spawnProcessId, boolean copyData, ParametersXto parameters, Boolean abortProcessInstance, SpawnModeXto spawnMode, String comment)
          Spawns a new root process and creates a link of type ProcessInstanceLinkType.SWITCH to the specified process instance.
 ProcessInstancesXto spawnSubprocessInstances(long processInstanceOid, ProcessSpawnInfosXto processSpawnInfos)
          Spawns multiple processes as subprocesses of the specified process instance.
 ProcessInstanceXto startProcess(String processId, ParametersXto parameters, Boolean startSynchronously, InputDocumentsXto attachments, String benchmarkId)
          Starts the process specified by the given ID using the provided data and returns the newly created process instance.
 ActivityInstanceXto suspendActivity(long activityOid, ParticipantInfoBaseXto participant, String context, ParametersXto outDataValues)
          Suspends the specified activity instance to the a participant as follows: If no participant is specified, the activity is added to the same worklist in which it was prior to activation.
 BusinessObjectXto updateBusinessObjectInstance(String qualifiedBusinessObjectId, ParameterXto newValue)
          Updates the value of a business object instance.
 void writeLogEntry(LogTypeXto logType, Long activityOid, Long processOid, String message)
          Logs an audit trail event of type LogCode.EXTERNAL.
 

Method Detail

hibernateActivity

@RequestWrapper(localName="hibernateActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.HibernateActivity")
@ResponseWrapper(localName="hibernateActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.HibernateActivityResponse")
ActivityInstanceXto hibernateActivity(long activityOid)
                                      throws BpmFault
Change the state of the specified activity instance to HIBERNATED.

Throws:
BpmFault

completeActivity

@RequestWrapper(localName="completeActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CompleteActivity")
@ResponseWrapper(localName="completeActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CompleteActivityResponse")
ActivityInstanceXto completeActivity(long activityOid,
                                                                                                                                      String context,
                                                                                                                                      ParametersXto outDataValues,
                                                                                                                                      Boolean activate)
                                     throws BpmFault
Completes the interactive activity instance identified by the activityOid on the behalf of the currently logged-in user.

Throws:
BpmFault

joinProcessInstance

@RequestWrapper(localName="joinProcessInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.JoinProcessInstance")
@ResponseWrapper(localName="joinProcessInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.JoinProcessInstanceResponse")
ProcessInstanceXto joinProcessInstance(long processInstanceOid,
                                                                                                                                        long targetProcessInstanceOid,
                                                                                                                                        String comment)
                                       throws BpmFault
Aborts the specified process instance and joins the data into the specified target process instance. Existing data values of the target process instance are not overwritten. Process attachments are merged.

Throws:
BpmFault

startProcess

@RequestWrapper(localName="startProcess",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.StartProcess")
@ResponseWrapper(localName="startProcessResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.StartProcessResponse")
ProcessInstanceXto startProcess(String processId,
                                                                                                                                 ParametersXto parameters,
                                                                                                                                 Boolean startSynchronously,
                                                                                                                                 InputDocumentsXto attachments,
                                                                                                                                 String benchmarkId)
                                throws BpmFault
Starts the process specified by the given ID using the provided data and returns the newly created process instance.

Throws:
BpmFault

activateActivity

@RequestWrapper(localName="activateActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ActivateActivity")
@ResponseWrapper(localName="activateActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ActivateActivityResponse")
ActivityInstanceXto activateActivity(long activityOid)
                                     throws BpmFault
Activates the interactive activity instance identified by the activityOID.

Throws:
BpmFault

delegateActivity

@RequestWrapper(localName="delegateActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DelegateActivity")
@ResponseWrapper(localName="delegateActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DelegateActivityResponse")
ActivityInstanceXto delegateActivity(long activityOid,
                                                                                                                                      ParticipantInfoBaseXto participant)
                                     throws BpmFault
Delegates the activity instance to the specified participant as follows: If the participant is a DefaultPerformer, the activity is delegated to the default performer. If the participant is an instance of UserInfo, the activity is delegated to the specified user. If the participant is an instance of UserGroupInfo, it the activity is delegated to the specified user group. If the participant is an instance of ModelParticipantInfo, it the activity is delegated to the specified model participant.

Throws:
BpmFault

abortProcessInstance

@RequestWrapper(localName="abortProcessInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.AbortProcessInstance")
@ResponseWrapper(localName="abortProcessInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.AbortProcessInstanceResponse")
ProcessInstanceXto abortProcessInstance(long oid,
                                                                                                                                         AbortScopeXto abortScope)
                                        throws BpmFault
Aborts the specified process instance. Depending on the scope, it will abort either this process instance only (including eventual subprocesses) or the whole process hierarchy starting with the root process.

Throws:
BpmFault

createActivityEventBinding

@RequestWrapper(localName="createActivityEventBinding",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateActivityEventBinding")
@ResponseWrapper(localName="createActivityEventBindingResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateActivityEventBindingResponse")
ActivityEventBindingXto createActivityEventBinding(long activityOid,
                                                                                                                                                    ActivityEventBindingXto bindingInfo)
                                                   throws BpmFault
Binds an event handler to the specified activity instance.

Throws:
BpmFault

setProcessProperties

@RequestWrapper(localName="setProcessProperties",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SetProcessProperties")
@ResponseWrapper(localName="setProcessPropertiesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SetProcessPropertiesResponse")
void setProcessProperties(long processInstanceOid,
                                                                                                                           InstancePropertiesXto processProperties)
                          throws BpmFault
Sets multiple OUT data paths on a process instance as specified in the corresponding process definition. New notes can be added by using the following parameters. The element named 'xml' must not exist. (name='Note' namespace='http://eclipse.org/stardust/ws/v2012a/api' xml=empty primitive='your note text here')

Throws:
BpmFault

suspendActivity

@RequestWrapper(localName="suspendActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SuspendActivity")
@ResponseWrapper(localName="suspendActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SuspendActivityResponse")
ActivityInstanceXto suspendActivity(long activityOid,
                                                                                                                                     ParticipantInfoBaseXto participant,
                                                                                                                                     String context,
                                                                                                                                     ParametersXto outDataValues)
                                    throws BpmFault
Suspends the specified activity instance to the a participant as follows: If no participant is specified, the activity is added to the same worklist in which it was prior to activation. If the participant is a DefaultPerformer, the activity is suspended to the default performer. If the participant is an instance of UserInfo, the activity is suspended to the specified user. If the participant is an instance of UserGroupInfo, it the activity is suspended to the specified user group. If the participant is an instance of ModelParticipantInfo, it the activity is suspended to the specified model participant.

Throws:
BpmFault

activateNextActivityForProcess

@RequestWrapper(localName="activateNextActivityForProcess",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ActivateNextActivityForProcess")
@ResponseWrapper(localName="activateNextActivityForProcessResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ActivateNextActivityForProcessResponse")
ActivityInstanceXto activateNextActivityForProcess(long processOid)
                                                   throws BpmFault
Activates the next activity instance for the specified process instance.

Throws:
BpmFault

leaveCase

@RequestWrapper(localName="leaveCase",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.LeaveCase")
@ResponseWrapper(localName="leaveCaseResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.LeaveCaseResponse")
ProcessInstanceXto leaveCase(long caseOid,
                                                                                                                              OidListXto memberOids)
                             throws BpmFault
Removes the process instances referenced by the specified memberOids from the specified case process instance.

Throws:
BpmFault

getSessionUser

@RequestWrapper(localName="getSessionUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetSessionUser")
@ResponseWrapper(localName="getSessionUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetSessionUserResponse")
UserXto getSessionUser()
                       throws BpmFault
Retrieves information on the current user.

Throws:
BpmFault

removeProcessEventBinding

@RequestWrapper(localName="removeProcessEventBinding",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.RemoveProcessEventBinding")
@ResponseWrapper(localName="removeProcessEventBindingResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.RemoveProcessEventBindingResponse")
ProcessEventBindingXto removeProcessEventBinding(long processOid,
                                                                                                                                                  String eventHandlerId)
                                                 throws BpmFault
Unbinds an event handler from the specified process instance.

Throws:
BpmFault

mergeCases

@RequestWrapper(localName="mergeCases",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.MergeCases")
@ResponseWrapper(localName="mergeCasesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.MergeCasesResponse")
ProcessInstanceXto mergeCases(long targetCaseOid,
                                                                                                                               OidListXto sourceCaseOids,
                                                                                                                               String comment)
                              throws BpmFault
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.

Throws:
BpmFault

getStartableProcessDefinitions

@RequestWrapper(localName="getStartableProcessDefinitions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetStartableProcessDefinitions")
@ResponseWrapper(localName="getStartableProcessDefinitionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetStartableProcessDefinitionsResponse")
ProcessDefinitionsXto getStartableProcessDefinitions()
                                                     throws BpmFault
Retrieves the list of process definitions that can be started by the current user.

Throws:
BpmFault

createProcessEventBinding

@RequestWrapper(localName="createProcessEventBinding",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateProcessEventBinding")
@ResponseWrapper(localName="createProcessEventBindingResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateProcessEventBindingResponse")
ProcessEventBindingXto createProcessEventBinding(long processOid,
                                                                                                                                                  ProcessEventBindingXto bindingInfo)
                                                 throws BpmFault
Binds an event handler to the specified process instance.

Throws:
BpmFault

abortActivity

@RequestWrapper(localName="abortActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.AbortActivity")
@ResponseWrapper(localName="abortActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.AbortActivityResponse")
ActivityInstanceXto abortActivity(long activityOid,
                                                                                                                                   AbortScopeXto abortScope)
                                  throws BpmFault
Aborts the specified activity instance, effectively aborting the whole process instance hierarchy this activity instance belongs to.

Throws:
BpmFault

getPermissions

@RequestWrapper(localName="getPermissions",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetPermissions")
@ResponseWrapper(localName="getPermissionsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetPermissionsResponse")
PermissionsXto getPermissions()
                              throws BpmFault
Retrieves all permissions the current user has on this service.

Throws:
BpmFault

updateBusinessObjectInstance

@RequestWrapper(localName="updateBusinessObjectInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.UpdateBusinessObjectInstance")
@ResponseWrapper(localName="updateBusinessObjectInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.UpdateBusinessObjectInstanceResponse")
BusinessObjectXto updateBusinessObjectInstance(String qualifiedBusinessObjectId,
                                                                                                                                                ParameterXto newValue)
                                               throws BpmFault
Updates the value of a business object instance.

Throws:
BpmFault

activateActivityAndGetInData

@RequestWrapper(localName="activateActivityAndGetInData",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ActivateActivityAndGetInData")
@ResponseWrapper(localName="activateActivityAndGetInDataResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ActivateActivityAndGetInDataResponse")
ParametersXto activateActivityAndGetInData(long activityOid,
                                                                                                                                            String context)
                                           throws BpmFault
Activates the interactive activity instance identified by the activityOID and retrieves all evaluated IN data mappings that match the provided interaction context for the specified activity.

Throws:
BpmFault

spawnSubprocessInstances

@RequestWrapper(localName="spawnSubprocessInstances",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SpawnSubprocessInstances")
@ResponseWrapper(localName="spawnSubprocessInstancesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SpawnSubprocessInstancesResponse")
ProcessInstancesXto spawnSubprocessInstances(long processInstanceOid,
                                                                                                                                              ProcessSpawnInfosXto processSpawnInfos)
                                             throws BpmFault
Spawns multiple processes as subprocesses of the specified process instance. The spawned processes execute asynchronously but have to be completed before the parent process is able to complete.

Throws:
BpmFault

spawnPeerProcessInstance

@RequestWrapper(localName="spawnPeerProcessInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.SpawnPeerProcessInstance")
@ResponseWrapper(localName="spawnPeerProcessInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.SpawnPeerProcessInstanceResponse")
ProcessInstanceXto spawnPeerProcessInstance(long processInstanceOid,
                                                                                                                                             String spawnProcessId,
                                                                                                                                             boolean copyData,
                                                                                                                                             ParametersXto parameters,
                                                                                                                                             Boolean abortProcessInstance,
                                                                                                                                             SpawnModeXto spawnMode,
                                                                                                                                             String comment)
                                            throws BpmFault
Spawns a new root process and creates a link of type ProcessInstanceLinkType.SWITCH to the specified process instance. Optionally existing data from the specified process instance can be copied to the newly spawned process.

Throws:
BpmFault

getProcessEventBinding

@RequestWrapper(localName="getProcessEventBinding",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetProcessEventBinding")
@ResponseWrapper(localName="getProcessEventBindingResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetProcessEventBindingResponse")
ProcessEventBindingXto getProcessEventBinding(long processOid,
                                                                                                                                               String eventHandlerId)
                                              throws BpmFault
Gets the binding state of an event handler for the specified process instance.

Throws:
BpmFault

getProcess

@RequestWrapper(localName="getProcess",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetProcess")
@ResponseWrapper(localName="getProcessResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetProcessResponse")
ProcessInstanceXto getProcess(long processOid)
                              throws BpmFault
Retrieves the specified process instance.

Throws:
BpmFault

getActivityEventBinding

@RequestWrapper(localName="getActivityEventBinding",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetActivityEventBinding")
@ResponseWrapper(localName="getActivityEventBindingResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetActivityEventBindingResponse")
ActivityEventBindingXto getActivityEventBinding(long activityOid,
                                                                                                                                                 String eventHandlerId)
                                                throws BpmFault
Gets the binding state of an event handler for the specified activity instance.

Throws:
BpmFault

getProcessProperties

@RequestWrapper(localName="getProcessProperties",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetProcessProperties")
@ResponseWrapper(localName="getProcessPropertiesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetProcessPropertiesResponse")
InstancePropertiesXto getProcessProperties(long processInstanceOid,
                                                                                                                                            org.eclipse.stardust.engine.api.ws.GetProcessProperties.PropertyIdsXto propertyIds)
                                           throws BpmFault
Retrieves multiple IN data paths from a process instance as specified in the corresponding process definition. Also notes are contained and are identified by the following parameters. (name='Note' namespace='http://eclipse.org/stardust/ws/v2012a/api')

Throws:
BpmFault

createCase

@RequestWrapper(localName="createCase",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateCase")
@ResponseWrapper(localName="createCaseResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateCaseResponse")
ProcessInstanceXto createCase(String name,
                                                                                                                               String description,
                                                                                                                               OidListXto memberOids)
                              throws BpmFault
Creates a case process instance which groups the specified members as subprocesses.

Throws:
BpmFault

activateNextActivity

@RequestWrapper(localName="activateNextActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ActivateNextActivity")
@ResponseWrapper(localName="activateNextActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ActivateNextActivityResponse")
ActivityInstanceXto activateNextActivity(Long activityOid,
                                                                                                                                          WorklistQueryXto worklistQuery)
                                         throws BpmFault
Activates the next activity instance after the specified one in the same process instance.

Throws:
BpmFault

deleteBusinessObjectInstance

@RequestWrapper(localName="deleteBusinessObjectInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DeleteBusinessObjectInstance")
@ResponseWrapper(localName="deleteBusinessObjectInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DeleteBusinessObjectInstanceResponse")
void deleteBusinessObjectInstance(String qualifiedBusinessObjectId,
                                                                                                                                   ParameterXto primaryKey)
                                  throws BpmFault
Deletes a business object instance.

Throws:
BpmFault

createBusinessObjectInstance

@RequestWrapper(localName="createBusinessObjectInstance",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateBusinessObjectInstance")
@ResponseWrapper(localName="createBusinessObjectInstanceResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateBusinessObjectInstanceResponse")
BusinessObjectXto createBusinessObjectInstance(String qualifiedBusinessObjectId,
                                                                                                                                                ParameterXto initialValue)
                                               throws BpmFault
Creates a new business object instance if it does not exist.

Throws:
BpmFault

delegateCase

@RequestWrapper(localName="delegateCase",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DelegateCase")
@ResponseWrapper(localName="delegateCaseResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DelegateCaseResponse")
ProcessInstanceXto delegateCase(long caseOid,
                                                                                                                                 ParticipantInfoXto participantInfo)
                                throws BpmFault
Delegates the case process instance to the specified participant.

Throws:
BpmFault

removeActivityEventBinding

@RequestWrapper(localName="removeActivityEventBinding",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.RemoveActivityEventBinding")
@ResponseWrapper(localName="removeActivityEventBindingResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.RemoveActivityEventBindingResponse")
ActivityEventBindingXto removeActivityEventBinding(long activityOid,
                                                                                                                                                    String eventHandlerId)
                                                   throws BpmFault
Unbinds an event handler from the specified activity instance.

Throws:
BpmFault

getActivity

@RequestWrapper(localName="getActivity",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetActivity")
@ResponseWrapper(localName="getActivityResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetActivityResponse")
ActivityInstanceXto getActivity(long activityOid)
                                throws BpmFault
Retrieves the specified activity instance.

Throws:
BpmFault

completeActivityAndActivateNext

@RequestWrapper(localName="completeActivityAndActivateNext",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CompleteActivityAndActivateNext")
@ResponseWrapper(localName="completeActivityAndActivateNextResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CompleteActivityAndActivateNextResponse")
ActivityInstancesXto completeActivityAndActivateNext(long activityOid,
                                                                                                                                                      String context,
                                                                                                                                                      ParametersXto outDataValues,
                                                                                                                                                      Boolean activate)
                                                     throws BpmFault
Completes the interactive activity instance identified by the activityOid on the behalf of the currently logged-in user and activates the next activity instance after the specified one in the same process instance.

Throws:
BpmFault

writeLogEntry

@RequestWrapper(localName="writeLogEntry",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.WriteLogEntry")
@ResponseWrapper(localName="writeLogEntryResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.WriteLogEntryResponse")
void writeLogEntry(LogTypeXto logType,
                                                                                                                    Long activityOid,
                                                                                                                    Long processOid,
                                                                                                                    String message)
                   throws BpmFault
Logs an audit trail event of type LogCode.EXTERNAL.

Throws:
BpmFault

findWorklist

@RequestWrapper(localName="findWorklist",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.FindWorklist")
@ResponseWrapper(localName="findWorklistResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.FindWorklistResponse")
WorklistXto findWorklist(WorklistQueryXto worklistQuery)
                         throws BpmFault
Retrieves (parts of) the worklist of the current logged in user satisfying the criteria specified in the provided query.

Throws:
BpmFault

joinCase

@RequestWrapper(localName="joinCase",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.JoinCase")
@ResponseWrapper(localName="joinCaseResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.JoinCaseResponse")
ProcessInstanceXto joinCase(long caseOid,
                                                                                                                             OidListXto memberOids)
                            throws BpmFault
Adds the process instances referenced by the specified memberOids to the specified case process instance.

Throws:
BpmFault

getActivityInData

@RequestWrapper(localName="getActivityInData",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetActivityInData")
@ResponseWrapper(localName="getActivityInDataResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetActivityInDataResponse")
ParametersXto getActivityInData(long activityOid,
                                                                                                                                 String context,
                                                                                                                                 org.eclipse.stardust.engine.api.ws.GetActivityInData.DataIdsXto dataIds)
                                throws BpmFault
Retrieves all evaluated IN data mappings that match the provided interaction context for the specified activity.

Throws:
BpmFault


Copyright © 2017 Eclipse Stardust. All Rights Reserved.