|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
ActivityInstance[] |
activityInstances()
Returns the activity instances which are represented by the instance monitor. |
ControlConnectorInstance[] |
controlConnectorInstances()
Returns the control connector instances which are represented by the instance monitor. |
InstanceMonitor |
obtainBlockMonitor(ActivityInstance activity)
This API call retrieves the instance monitor for the specified activity instance from the MQ Workflow execution server (action call). |
InstanceMonitor |
obtainProcessMonitor(ActivityInstance activity,
boolean deep)
See obtainBlockMonitor(com.ibm.workflow.api.ActivityInstance) ; obtains the monitor for an activity of type
Process. |
java.lang.String |
persistentOid()
Returns a representation of the object identification of the instance monitor. |
void |
refresh(boolean deep)
This API call refreshes the instance monitor from the MQ Workflow execution server (action call). |
Method Detail |
public ActivityInstance[] activityInstances() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ControlConnectorInstance[] controlConnectorInstances() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String persistentOid() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public InstanceMonitor obtainBlockMonitor(ActivityInstance activity) throws FmcException
This API call retrieves the instance monitor for the specified activity instance from the MQ Workflow execution server (action call). If the requested instance monitor has already been retrieved from the server, the monitor found in the API cache is returned to the caller.
When the monitor for a process instance is retrieved, the specified activity instance must be of type Process and be part of this instance monitor.
When the monitor for a block is retrieved, the specified activity instance must be of type Block and be part of this instance monitor.
When the deep option is specified, nested activity instances of type Block are resolved, that is, their instance monitors are also read from the server.
FmcException
- thrown if an API error or a communication error occurred.public InstanceMonitor obtainProcessMonitor(ActivityInstance activity, boolean deep) throws FmcException
obtainBlockMonitor(com.ibm.workflow.api.ActivityInstance)
; obtains the monitor for an activity of type
Process.
FmcException
- thrown if an API error or a communication error occurred.public void refresh(boolean deep) throws FmcException
This API call refreshes the instance monitor from the MQ Workflow execution server (action call).
All information about the instance monitor is retrieved.
When the deep option is specified, then activity instances of type Block are resolved, that is, their instance monitors are also refreshed from the server.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |