org.enhydra.shark.api.client.wfservice
Interface ExecutionAdministrationExt


public interface ExecutionAdministrationExt

Extension of client side interface enabling user to do various things such as to navigate through process instance or fastly delete finished process instances.

Author:
Sasa Bojanic, Vladimir Puskas

Method Summary
 void deleteProcessInstances(WMSessionHandle shandle, WMFilter procFilter, int depth, int maxExceptions, int preferredTime, int waitingTime, int minBatchSize)
          Fast deleting of finished shark process instances and all othere related entities (activities, assignments, variables, ....).
 WMActivityInstance goAnywhere(WMSessionHandle shandle, java.lang.String processId, java.lang.String actId, java.lang.String nextActDefId, WMAttribute[] context)
          Navigation through the running process instance.
 WMActivityInstance goBack(WMSessionHandle shandle, java.lang.String processId, boolean onlyToManual, WMAttribute[] context)
          Back navigation through the running process instance.
 WMActivityInstance goForth(WMSessionHandle shandle, java.lang.String processId, WMAttribute[] context)
          Forward navigation through the running process instance.
 void goNext(WMSessionHandle shandle, java.lang.String procId, java.lang.String actId, WMAttribute[] context)
          Navigation through the running process instance (process must be in 'open.running' state).
 WMActivityInstance goPrevious(WMSessionHandle shandle, java.lang.String procId, java.lang.String actId, WMAttribute[] context)
          Navigation through the running process instance (process must be in 'open.running' state) to the 'Manual' activity completed prior to the given running activity.
 void migrateProcessVersion(WMSessionHandle shandle, java.lang.String procDefUniqueName, java.lang.String procId)
           
 WMActivityInstanceIterator reevaluateAssignmentsForUser(WMSessionHandle shandle, java.lang.String username, boolean returnChangedOnly)
          Reevaluates assignments for the active, non-accepted activities of the specified user.
 

Method Detail

goBack

WMActivityInstance goBack(WMSessionHandle shandle,
                          java.lang.String processId,
                          boolean onlyToManual,
                          WMAttribute[] context)
                          throws java.lang.Exception
Back navigation through the running process instance. It is assumed that process is running, that there is only one activity running, and that there is only one activity in XPDL definition prior to the currently running activity. Implementation of this API method must: NOTE: if block activities are used, be sure that you do not nest them - it won't work properly in that case. Also, be sure that ActivitySet is referenced from only one block activity.

Throws:
java.lang.Exception

goForth

WMActivityInstance goForth(WMSessionHandle shandle,
                           java.lang.String processId,
                           WMAttribute[] context)
                           throws java.lang.Exception
Forward navigation through the running process instance. It is assumed that process is running, that there is only one activity running, and that there is only one activity in XPDL definition following the currently running activity. Implementation of this API method must: NOTE: if block activities are used, be sure that you do not nest them - it won't work properly in that case.

Throws:
java.lang.Exception

goAnywhere

WMActivityInstance goAnywhere(WMSessionHandle shandle,
                              java.lang.String processId,
                              java.lang.String actId,
                              java.lang.String nextActDefId,
                              WMAttribute[] context)
                              throws java.lang.Exception
Navigation through the running process instance. It is assumed that process is running, in the case you don't provide 'actId' parameter (it is null) that there is only one activity running, and that there is activity in XPDL definition with a given definition Id. Implementation of this API method must: NOTE: if block activities are used, be sure that you do not nest them - it won't work properly in that case. Also, be sure that ActivitySet is referenced from only one block activity.

Throws:
java.lang.Exception

goPrevious

WMActivityInstance goPrevious(WMSessionHandle shandle,
                              java.lang.String procId,
                              java.lang.String actId,
                              WMAttribute[] context)
                              throws java.lang.Exception
Navigation through the running process instance (process must be in 'open.running' state) to the 'Manual' activity completed prior to the given running activity. Implementation of this API method must: NOTE: if block activities are used, be sure that you do not nest them - it won't work properly in some cases. Also, be sure that ActivitySet is referenced from only one block activity.

Throws:
java.lang.Exception

goNext

void goNext(WMSessionHandle shandle,
            java.lang.String procId,
            java.lang.String actId,
            WMAttribute[] context)
            throws java.lang.Exception
Navigation through the running process instance (process must be in 'open.running' state). Implementation of this API method must:

Throws:
java.lang.Exception

deleteProcessInstances

void deleteProcessInstances(WMSessionHandle shandle,
                            WMFilter procFilter,
                            int depth,
                            int maxExceptions,
                            int preferredTime,
                            int waitingTime,
                            int minBatchSize)
                            throws java.lang.Exception
Fast deleting of finished shark process instances and all othere related entities (activities, assignments, variables, ....).

IMPORTANT NOTE: This method won't work with MySQL databases.

Parameters:
shandle -
procFilter - the filter that can be provided to specify a criteria for deleting processes (i.e. only processes from a certain definition(s)). If it is null, all the finished processes will be deleted from DB.
depth - must be specified to the maximum value of nested sub-process instances
maxExceptions - maximum number of exceptions to ignore during process instance deletion before actual exception is thrown to the user
preferredTime - time in milliseconds for which you would like deletion of a group of process instances is deleted
waitingTime - time in milliseconds to wait before starting another group deletion
minBatchSize - minimum number of process instances to be deleted in one pass (the minimum size of group of processes to be deleted)
Throws:
java.lang.Exception

reevaluateAssignmentsForUser

WMActivityInstanceIterator reevaluateAssignmentsForUser(WMSessionHandle shandle,
                                                        java.lang.String username,
                                                        boolean returnChangedOnly)
                                                        throws java.lang.Exception
Reevaluates assignments for the active, non-accepted activities of the specified user.

Throws:
java.lang.Exception

migrateProcessVersion

void migrateProcessVersion(WMSessionHandle shandle,
                           java.lang.String procDefUniqueName,
                           java.lang.String procId)
                           throws java.lang.Exception
Parameters:
shandle -
newProcDef -
procDefUniqueName -
procId -
Throws:
java.lang.Exception