All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.ExecutionAgent

public interface ExecutionAgent
Version:
3.2.0.2

Method Index

 o inContainer()

This function/method retrieves the input container from the MQ Workflow program execution agent (activity implementation call).

 o outContainer()

This function/method retrieves the output container from the MQ Workflow program execution agent (activity implementation call).

 o programID()
Returns the program identification by which the invoked activity implementation is known to the program execution agent.
 o remoteInContainer(String)

This function/method retrieves the input container from the MQ Workflow program execution agent (activity implementation call).

 o remoteOutContainer(String)

This function/method retrieves the output container from the MQ Workflow program execution agent (activity implementation call).

 o remoteUserID(String)
Returns the user identification on whose behalf the activity implementation who started this program was originally started.
 o setOutContainer(ReadWriteContainer)

This function/method returns the output container to the MQ Workflow program execution agent (activity implementation call).

 o setRemoteOutContainer(String, ReadWriteContainer)

This function/method returns the output container to the MQ Workflow program execution agent (activity implementation call).

 o userID()
Returns the user identification on whose behalf the activity implementation was started.

Methods

 o userID
 public abstract String userID() throws FmcException
Returns the user identification on whose behalf the activity implementation was started.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o inContainer
 public abstract ReadOnlyContainer inContainer() throws FmcException

This function/method retrieves the input container from the MQ Workflow program execution agent (activity implementation call).

It can be used from within an activity implementation or support tool.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o outContainer
 public abstract ReadWriteContainer outContainer() throws FmcException

This function/method retrieves the output container from the MQ Workflow program execution agent (activity implementation call).

It can be used from within an activity implementation.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o programID
 public abstract String programID() throws FmcException
Returns the program identification by which the invoked activity implementation is known to the program execution agent.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o remoteInContainer
 public abstract ReadOnlyContainer remoteInContainer(String programID) throws FmcException

This function/method retrieves the input container from the MQ Workflow program execution agent (activity implementation call).

It can be used from within a program started by an activity implementation or support tool.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o remoteOutContainer
 public abstract ReadWriteContainer remoteOutContainer(String programID) throws FmcException

This function/method retrieves the output container from the MQ Workflow program execution agent (activity implementation call).

It can be used from within a program started by an activity implementation.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o remoteUserID
 public abstract String remoteUserID(String programID) throws FmcException
Returns the user identification on whose behalf the activity implementation who started this program was originally started.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o setOutContainer
 public abstract void setOutContainer(ReadWriteContainer outContainer) throws FmcException

This function/method returns the output container to the MQ Workflow program execution agent (activity implementation call).

It can be used from within an activity implementation as often as required. Note, however, that the output container is not returned to the MQ Workflow execution server until the activity implementation ends. It is kept transiently by the program execution agent.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o setRemoteOutContainer
 public abstract void setRemoteOutContainer(String programID,
                                            ReadWriteContainer container) throws FmcException

This function/method returns the output container to the MQ Workflow program execution agent (activity implementation call).

It can be used from within a program started by an activity implementation as often as required. Note, however, that the output container is not returned to the MQ Workflow execution server until the activity implementation ends. It is kept transiently by the program execution agent.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index