All Packages Class Hierarchy This Package Previous Next Index
This function/method cancels the checkout of the work item (action call).
This function/method allows for the check in of a work item that was previously checked out for user processing (action call).
This function/method checks out a ready work item for user processing (action call).
See checkOut; additionally allows for specifying which program definitions to retrieve.
This function/method ends the execution of a manual-exit work item (action call).
This function/method ends the execution of a work item which is known to have completed in cases where MQ Workflow did not recognize this event (action call).
This function/method forces MQ Workflow to enable the restart of a work item (action call).
This function/method retrieves the input container associated with the work item from the MQ Workflow execution server (action call).
This function/method retrieves the output container associated with the work item from the MQ Workflow execution server (action call).
This function/method asks MQ Workflow to enable the restart of a work item (action call).
This function/method starts a ready work item (action call).
This function/method starts the specified support tool (action call).
This function/method terminates a work item implemented by a program or process (action call).
public abstract Type activityKind() throws FmcException
public abstract FmcError errorReason() throws FmcException
public abstract String exitCondition() throws FmcException
public abstract Calendar firstNotificationTime() throws FmcException
public abstract String implementation() throws FmcException
public abstract boolean manualExitMode() throws FmcException
public abstract boolean manualStartMode() throws FmcException
public abstract int priority() throws FmcException
public abstract Calendar secondNotificationTime() throws FmcException
public abstract String[] staff() throws FmcException
public abstract String startCondition() throws FmcException
public abstract ExecutionState state() throws FmcException
public abstract Escalation stateOfNotification() throws FmcException
public abstract String[] supportTools() throws FmcException
public abstract void cancelCheckOut() throws FmcException
This function/method cancels the checkout of the work item (action call).
The work item must have been checked out and is put into the Ready state. The associated process instance must be in the Running, Suspending, Suspended, or Terminating state.
public abstract void checkIn(ReadWriteContainer outContainer, int returnCode) throws FmcException
This function/method allows for the check in of a work item that was previously checked out for user processing (action call).
Checking in a work item tells MQ Workflow that user processing has finished and workflow processing under the control of MQ Workflow can continue. The return code of the user processing and, optionally, the output container values are passed back to MQ Workflow. As usual, these container values and the return code can be used in exit conditions to let navigation continue depending on the success of the processing and in transition conditions to indicate how to proceed.
public abstract ReadOnlyContainer checkOut() throws FmcException
This function/method checks out a ready work item for user processing (action call).
The work item must be implemented by a program.
Checkout then means that processing is not done by MQ Workflow's inherent program-invocation mechanism. MQ Workflow assumes that processing is done by user-specific means and changes the state of the work item to CheckedOut.
The associated process instance must be in the Running state.
The caller can request program definitions for specific operating system platforms. The following enumeration types can be used to specify the requested program data.
The enumeration constants can take the following values; it is strongly advised to use the symbolic names instead of the associated integer values.
The following enumeration types can be used to specify the platform for which program definitions are to be retrieved.
The enumeration constants can take the following values; it is strongly advised to use the symbolic names instead of the associated integer values.
public abstract ProgramData checkOut2(ProgramRetrieval requestedData, Basis platform) throws FmcException
See checkOut; additionally allows for specifying which program definitions to retrieve.
public abstract void finish() throws FmcException
This function/method ends the execution of a manual-exit work item (action call).
The work item must be in state Executed, that is, must have run at least once. The work item is then put into the Finished state. Depending on the "delete finished items" option, it is deleted.
public abstract void forceFinish() throws FmcException
This function/method ends the execution of a work item which is known to have completed in cases where MQ Workflow did not recognize this event (action call).
This situation can occur when the execution server aborted before it received the activity implementation completion message.
A work item implemented by a program must be in the states Ready, Running, Executed, CheckedOut, InError, Terminating, or Terminated. A work item implemented by a process must be in the states Ready, Executed, InError, or Terminated. The associated process instance must be in the states Running, Suspending, Suspended, or Terminating.
The work item is then put into the ForceFinished state. The exit condition is considered to be true and navigation proceeds.
Depending on the "delete finished items" option, the work item is deleted.
public abstract void forceRestart() throws FmcException
This function/method forces MQ Workflow to enable the restart of a work item (action call).
A work item implemented by a program must be in states Running, Executed, CheckedOut, InError, Terminating, or Terminated. A work item implemented by a process must be in states Executed, InError, or Terminated. The associated process instance must be in states Running, Suspending, or Suspended.
It is then reset into the Ready state. Note that automatic activity instances must now be started manually.
public abstract ReadOnlyContainer inContainer() throws FmcException
This function/method retrieves the input container associated with the work item from the MQ Workflow execution server (action call).
public abstract ReadWriteContainer outContainer() throws FmcException
This function/method retrieves the output container associated with the work item from the MQ Workflow execution server (action call).
public abstract void restart() throws FmcException
This function/method asks MQ Workflow to enable the restart of a work item (action call).
The work item must be in state Executed. It is then reset into the Ready state.
public abstract void start() throws FmcException
This function/method starts a ready work item (action call).
The associated process instance must be in the Running state.
If the associated activity instance is implemented by a program, the program is started on the program execution agent associated to the logged-on user.
The work item is put into the Running state. If the activity implementation or an associated process activity cannot be started, the work item is put into the InError state.
public abstract void startTool(String toolName) throws FmcException
This function/method starts the specified support tool (action call).
The support tool must be one of the tools associated to the activity instance the work item is derived from. It is then started on the program execution agent associated to the logged-on user.
public abstract void terminate() throws FmcException
This function/method terminates a work item implemented by a program or process (action call).
If the work item is implemented by a program, it must be in the states CheckedOut or Running and the process instance must be in the states Running, Suspending, or Suspended. If the work item is implemented by a process, it must be in the states Running, Suspending, or Suspended and the process instance must be in the states Running, Suspending, Suspended, or Terminating.
A work item implemented by a process is terminated together with all its non-autonomous subprocesses with respect to control autonomy.
The work item is then put into the Terminating or Terminated state.
Depending on the "delete finished items" option, the work item is deleted.
When the Terminated state has been reached, the exit condition is considered to be false, the output container and especially the return code (_RC) are not set, and navigation ends. If not yet deleted, navigation can be explicitly continued by a user with process administration rights, that is, ForceFinish() or ForceRestart() repair actions can be called.
All Packages Class Hierarchy This Package Previous Next Index