com.ibm.workflow.api
Interface InstanceMonitor


public interface InstanceMonitor


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

activityInstances

public ActivityInstance[] activityInstances()
                                     throws FmcException
Returns the activity instances which are represented by the instance monitor. The activity instances contain both primary and secondary values.

Throws:
FmcException - thrown if an API error or a communication error occurred.

controlConnectorInstances

public ControlConnectorInstance[] controlConnectorInstances()
                                                     throws FmcException
Returns the control connector instances which are represented by the instance monitor.

Throws:
FmcException - thrown if an API error or a communication error occurred.

persistentOid

public java.lang.String persistentOid()
                               throws FmcException
Returns a representation of the object identification of the instance monitor.

Throws:
FmcException - thrown if an API error or a communication error occurred.

obtainBlockMonitor

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.

Note:
Deep is currently not supported.
Throws:
FmcException - thrown if an API error or a communication error occurred.

obtainProcessMonitor

public InstanceMonitor obtainProcessMonitor(ActivityInstance activity,
                                            boolean deep)
                                     throws FmcException
See obtainBlockMonitor(com.ibm.workflow.api.ActivityInstance); obtains the monitor for an activity of type Process.

Throws:
FmcException - thrown if an API error or a communication error occurred.

refresh

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.

Note:
Deep is currently not supported.
Throws:
FmcException - thrown if an API error or a communication error occurred.


© Copyright IBM Corporation 1999, 2007. All Rights Reserved.