| org.enhydra.shark.api.client.wfservice.AdminMiscExt
All known Subclasses: org.enhydra.shark.ws.AdminMiscExtWrapper,
| AdminMiscExt | | public interface AdminMiscExt (Code) | | 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
author:
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, 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, 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, String procId, 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, 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. |
| getBeginningOptions | | OptionInfo[] getBeginningOptions(WMSessionHandle shandle, WMEntity procDefEnt, boolean provideTransitionInformation) throws Exception(Code) | | 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:
- the left side of expression must be XPDL process variable Id, which type is
either BasicType->String, BasicType->Integer, BasicType->Float or BasicType->Boolean
- the right side of expression must be expession that can be evaluated using
interpreter specified for this XPDL (JavaScript or Java), and must result in String,
Long, Long, Double or Boolean (depending on variable on the left side).
Here are the examples of valid expressions assuming that whereToGo is String and
navig is Integer variable:
- whereToGo.equals("A1")
- navig==32
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:
- If the Route activity is the next one, methods return info about activity(ies)
and correspondig transition(s) going from Route activity.
- Transition to Route activity must be either OTHERWISE, or the only one and
unconditional
|
| getFirstFinished | | WMActivityInstanceIterator getFirstFinished(WMSessionHandle shandle, String procId, int limit, boolean insideSameProcess) throws Exception(Code) | | 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.
|
| getLastFinished | | WMActivityInstanceIterator getLastFinished(WMSessionHandle shandle, String procId, int limit, boolean insideSameProcess) throws Exception(Code) | | 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.
|
| getNextOptions | | OptionInfo[] getNextOptions(WMSessionHandle shandle, WMEntity actDefEnt, boolean provideTransitionInformation, boolean skipAsyncSubflow) throws Exception(Code) | | 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:
- the left side of expression must be XPDL process variable Id, which type is
either BasicType->String, BasicType->Integer, BasicType->Float or BasicType->Boolean
- the right side of expression must be expession that can be evaluated using
interpreter specified for this XPDL (JavaScript or Java), and must result in String,
Long, Long, Double or Boolean (depending on variable on the left side).
Here are the examples of valid expressions assuming that whereToGo is String and
navig is Integer variable:
- whereToGo.equals("A1")
- navig==32
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:
- If the Route activity is the next one, methods return info about activity(ies)
and correspondig transition(s) going from Route activity.
- If the activity for which we are searching is the last one within the Block,
this method returns info about the activity following the corresponding Block
activity that encompasses this activity. (NOTE: it does not support nested block
activities).
- Transition to Route activity must be either OTHERWISE, or the only one and
unconditional
|
| getPrevious | | WMActivityInstance getPrevious(WMSessionHandle shandle, String procId, String actId, boolean insideSameProcess) throws Exception(Code) | | 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.
|
| getPreviousOptions | | OptionInfo[] getPreviousOptions(WMSessionHandle shandle, WMEntity actDefEnt, boolean findOnlyManual) throws Exception(Code) | | 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:
- If the Route activity is the previous one, method returns info about
activity(ies) and correspondig transition(s) preceding the Route activity.
- If parameter 'findOnlyManual' is set to true, and if activity different than
'No' is the previous one, method returns info about activity(ies) and correspondig
transition(s) preceding this activity.
- If the activity for which we are searching is the first one within the Block,
this method returns info about the activity preceding the corresponding Block
activity that encompasses this activity. (NOTE: it does not support nested block
activities).
|
| getRunningActivities | | WMActivityInstanceIterator getRunningActivities(WMSessionHandle shandle, String procId, boolean onlyManual) throws Exception(Code) | | 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.
|
|
|