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


public interface AdminMiscExt

Extended client side interface enabling user to do various things such as to get information about future or past activities from XPDL, or firstly or lastly executed activities within process instance.

Author:
Sasa Bojanic, Vladimir Puskas

Method Summary
 OptionInfo[] getBeginningOptions(WMSessionHandle shandle, WMEntity procDefEnt, boolean provideTransitionInformation)
          As a result of method getBeginningOptions, user will get an array of OptionInfo structure.
 WMEntityIterator getEndingActivities(WMSessionHandle shandle, WMEntity procDefEnt)
          Returns ending activities for the process definition determined by given entity.
 WMActivityInstanceIterator getFirstFinished(WMSessionHandle shandle, java.lang.String procId, int limit, boolean insideSameProcess)
          Returns maximally 'limit' number of (sorted by the time finished) first-finished 'Manual' activity instances from specified process or, if insideSameProcess parameter is false, some of its synchronous sub-processes.
 WMActivityInstanceIterator getLastFinished(WMSessionHandle shandle, java.lang.String procId, int limit, boolean insideSameProcess)
          Returns maximally 'limit' number of (sorted by the time finished) last-finished 'Manual' activity instances from specified process or, if insideSameProcess parameter is false, some of its synchronous sub-processes.
 OptionInfo[] getNextOptions(WMSessionHandle shandle, WMEntity actDefEnt, boolean provideTransitionInformation, boolean skipAsyncSubflow)
          As a result of method getNextOptions, user will get an array of OptionInfo structure.
 WMActivityInstance getPrevious(WMSessionHandle shandle, java.lang.String procId, java.lang.String actId, boolean insideSameProcess)
          Returns the 'Manual' activity completed prior to the given running activity from the given running process instance.
 OptionInfo[] getPreviousOptions(WMSessionHandle shandle, WMEntity actDefEnt, boolean findOnlyManual)
          As a result of method getPreviousOptions, user will get an array of OptionInfo structure.
 WMActivityInstanceIterator getRunningActivities(WMSessionHandle shandle, java.lang.String procId, boolean onlyManual)
          This method returns the information about activities waiting to execute for the given procesId.
 WMEntityIterator getStartingActivities(WMSessionHandle shandle, WMEntity procDefEnt)
          Returns starting activities for the process definition determined by given entity.
 ActivityHistoryInfo[] listActivityHistory(WMSessionHandle shandle, WMFilter filter, boolean fillVariablesInfo)
          This method returns the information about activity history.
 ActivityHistoryInfo[] listActivityHistoryReporting(WMSessionHandle shandle, WMFilter filter, boolean fillVariablesInfo)
          This method returns the information about activity history.
 ProcessHistoryInfo[] listProcessHistory(WMSessionHandle shandle, WMFilter filter, boolean fillActivitiesInfo, boolean fillActivitiyVariablesInfo, boolean fillVariablesInfo)
          This method returns the information about process history.
 ProcessHistoryInfo[] listProcessHistoryReporting(WMSessionHandle shandle, WMFilter filter, boolean fillActivitiesInfo, boolean fillActivitiyVariablesInfo, boolean fillVariablesInfo)
          This method returns the information about process history.
 ProcessDefinitionHistoryInfo[] listUsedProcessDefinitions(WMSessionHandle shandle, java.lang.String factoryName, boolean countProcessInstances)
          Returns object(s) describing Process Definition history.
 

Method Detail

getStartingActivities

WMEntityIterator getStartingActivities(WMSessionHandle shandle,
                                       WMEntity procDefEnt)
                                       throws java.lang.Exception
Returns starting activities for the process definition determined by given entity.

Throws:
java.lang.Exception

getEndingActivities

WMEntityIterator getEndingActivities(WMSessionHandle shandle,
                                     WMEntity procDefEnt)
                                     throws java.lang.Exception
Returns ending activities for the process definition determined by given entity.

Throws:
java.lang.Exception

getBeginningOptions

OptionInfo[] getBeginningOptions(WMSessionHandle shandle,
                                 WMEntity procDefEnt,
                                 boolean provideTransitionInformation)
                                 throws java.lang.Exception
As a result of method getBeginningOptions, user will get an array of OptionInfo structure. OptionInfo structure holds the information about activity definition, can hold information about Transition definition from the specified activity to target one. If user specifies that he wants to obtain transition information, user will get information necessary to navigate through the process by setting appropriate variable to a certain value before instantiating the process from definition, but in that case process definitions must not have AND Splits or Joins, and it is important that XPDL transition conditions are written by the given rules:

Here are the examples of valid expressions assuming that whereToGo is String and navig is Integer variable:

Also, in the case when user wants to obtain transition information, and if there are more transitions following from specified activity, each transition (except OTHERWISE transition and the transition going to Route activity) MUST have condition expression defined. There are several other rules regarding Route and Block activities in this case:

Throws:
java.lang.Exception

getNextOptions

OptionInfo[] getNextOptions(WMSessionHandle shandle,
                            WMEntity actDefEnt,
                            boolean provideTransitionInformation,
                            boolean skipAsyncSubflow)
                            throws java.lang.Exception
As a result of method getNextOptions, user will get an array of OptionInfo structure. OptionInfo structure holds the information about activity definition and information about Transition definition from the specified activity to target one. If user specifies that he wants to obtain transition information, which can be used to navigate through the process by setting appropriate variable to a certain value, process definitions must not have AND Splits or Joins, and it is important that XPDL transition conditions are written by the given rules:

Here are the examples of valid expressions assuming that whereToGo is String and navig is Integer variable:

Also, in the case when user wants to obtain transition information, and if there are more transitions following from specified activity, each transition (except OTHERWISE transition and the transition going to Route activity) MUST have condition expression defined. There are several other rules regarding Route and Block activities in this case:

Throws:
java.lang.Exception

getPreviousOptions

OptionInfo[] getPreviousOptions(WMSessionHandle shandle,
                                WMEntity actDefEnt,
                                boolean findOnlyManual)
                                throws java.lang.Exception
As a result of method getPreviousOptions, user will get an array of OptionInfo structure. OptionInfo structure holds the information about activity definition and information about Transition definition from the specified activity to previous one. There are several other rules regarding Route and Block activities in this case:

Throws:
java.lang.Exception

getFirstFinished

WMActivityInstanceIterator getFirstFinished(WMSessionHandle shandle,
                                            java.lang.String procId,
                                            int limit,
                                            boolean insideSameProcess)
                                            throws java.lang.Exception
Returns maximally 'limit' number of (sorted by the time finished) first-finished 'Manual' activity instances from specified process or, if insideSameProcess parameter is false, some of its synchronous sub-processes.

Throws:
java.lang.Exception

getLastFinished

WMActivityInstanceIterator getLastFinished(WMSessionHandle shandle,
                                           java.lang.String procId,
                                           int limit,
                                           boolean insideSameProcess)
                                           throws java.lang.Exception
Returns maximally 'limit' number of (sorted by the time finished) last-finished 'Manual' activity instances from specified process or, if insideSameProcess parameter is false, some of its synchronous sub-processes.

Throws:
java.lang.Exception

getPrevious

WMActivityInstance getPrevious(WMSessionHandle shandle,
                               java.lang.String procId,
                               java.lang.String actId,
                               boolean insideSameProcess)
                               throws java.lang.Exception
Returns the 'Manual' activity completed prior to the given running activity from the given running process instance. If specified so (by setting 'insideSameProcess' parameter to 'false'), the returned activity can be retrieved from another process which can be either sub-process of the specified process, or the process that instantiated specified process as its sub-flow.

Throws:
java.lang.Exception

getRunningActivities

WMActivityInstanceIterator getRunningActivities(WMSessionHandle shandle,
                                                java.lang.String procId,
                                                boolean onlyManual)
                                                throws java.lang.Exception
This method returns the information about activities waiting to execute for the given procesId. This activity state is either 'open.not_running.not_started' or 'open.running'. If process has sub-flow which state is 'open.running', it will search the sub-process to find its running activities. If there is a block activity in 'open.running' state, it won't be reported itself - only running activities inside block will be reported. If 'onlyManual' is ste to true, only purely 'Manual' activities will be returned.

Throws:
java.lang.Exception

listProcessHistory

ProcessHistoryInfo[] listProcessHistory(WMSessionHandle shandle,
                                        WMFilter filter,
                                        boolean fillActivitiesInfo,
                                        boolean fillActivitiyVariablesInfo,
                                        boolean fillVariablesInfo)
                                        throws java.lang.Exception
This method returns the information about process history.

Parameters:
shandle -
filter -
Returns:
Throws:
java.lang.Exception

listActivityHistory

ActivityHistoryInfo[] listActivityHistory(WMSessionHandle shandle,
                                          WMFilter filter,
                                          boolean fillVariablesInfo)
                                          throws java.lang.Exception
This method returns the information about activity history.

Parameters:
shandle -
filter -
Returns:
Throws:
java.lang.Exception

listProcessHistoryReporting

ProcessHistoryInfo[] listProcessHistoryReporting(WMSessionHandle shandle,
                                                 WMFilter filter,
                                                 boolean fillActivitiesInfo,
                                                 boolean fillActivitiyVariablesInfo,
                                                 boolean fillVariablesInfo)
                                                 throws java.lang.Exception
This method returns the information about process history.

Parameters:
shandle -
filter -
Returns:
Throws:
java.lang.Exception

listActivityHistoryReporting

ActivityHistoryInfo[] listActivityHistoryReporting(WMSessionHandle shandle,
                                                   WMFilter filter,
                                                   boolean fillVariablesInfo)
                                                   throws java.lang.Exception
This method returns the information about activity history.

Parameters:
shandle -
filter -
Returns:
Throws:
java.lang.Exception

listUsedProcessDefinitions

ProcessDefinitionHistoryInfo[] listUsedProcessDefinitions(WMSessionHandle shandle,
                                                          java.lang.String factoryName,
                                                          boolean countProcessInstances)
                                                          throws java.lang.Exception
Returns object(s) describing Process Definition history. If factoryName parameter is null you will get all the definitions and if not just a specified one. If countProcessInstances is true, you'll get information how many active and finished process instances there are for the definition.

Parameters:
shandle -
factoryName -
countProcessInstances -
Returns:
Throws:
java.lang.Exception