All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.BlockInstanceMonitor

public interface BlockInstanceMonitor
Version:
3.2.0.2

Method Index

 o activityInstances()
Returns the activity instances which are represented by the block instance monitor, that is, which are part of the activity instance of type Block.
 o controlConnectorInstances()
Returns the control connector instances which are represented by the block instance monitor, that is, which are part of the activity instance of type Block.
 o obtainBlockInstanceMonitor(ActivityInstance)

This function/method retrieves the block instance monitor for the specified activity instance from the MQ Workflow execution server (action call).

 o obtainProcessInstanceMonitor(ActivityInstance, boolean)

This function/method retrieves the process instance monitor for the specified activity instance from the MQ Workflow execution server (action call).

 o refresh(boolean)

This function/method refreshes the block instance monitor from the MQ Workflow execution server (action call).

Methods

 o activityInstances
 public abstract ActivityInstance[] activityInstances() throws FmcException
Returns the activity instances which are represented by the block instance monitor, that is, which are part of the activity instance of type Block. The activity instances contain both primary and secondary values.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o controlConnectorInstances
 public abstract ControlConnectorInstance[] controlConnectorInstances() throws FmcException
Returns the control connector instances which are represented by the block instance monitor, that is, which are part of the activity instance of type Block.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o obtainBlockInstanceMonitor
 public abstract BlockInstanceMonitor obtainBlockInstanceMonitor(ActivityInstance activity) throws FmcException

This function/method retrieves the block instance monitor for the specified activity instance from the MQ Workflow execution server (action call).

The specified activity instance must be of type Block and be part of this block instance monitor.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o obtainProcessInstanceMonitor
 public abstract ProcessInstanceMonitor obtainProcessInstanceMonitor(ActivityInstance activity,
                                                                     boolean deep) throws FmcException

This function/method retrieves the process instance monitor for the specified activity instance from the MQ Workflow execution server (action call).

The specified activity instance must be of type Process and be part of this block instance monitor.

When the deep option is specified, then activity instances of type Block are resolved, that is, their block instance monitors are also fetched from the server.
Note:Deep is currently not supported.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o refresh
 public abstract void refresh(boolean deep) throws FmcException

This function/method refreshes the block instance monitor from the MQ Workflow execution server (action call).

All information about the block instance monitor is retrieved.

When the deep option is specified, then activity instances of type Block are resolved, that is, their block 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index