All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.WorkItem

public interface WorkItem
extends Item
Version:
3.2.0.2

Method Index

 o activityKind()
Returns the kind of the associated activity instance, whether it is a program or process and so on.
 o cancelCheckOut()

This function/method cancels the checkout of the work item (action call).

 o checkIn(ReadWriteContainer, int)

This function/method allows for the check in of a work item that was previously checked out for user processing (action call).

 o checkOut()

This function/method checks out a ready work item for user processing (action call).

 o checkOut2(ProgramRetrieval, Basis)

See checkOut; additionally allows for specifying which program definitions to retrieve.

 o errorReason()
Returns an error object describing the reason why the associated activity instance is in state InError.
 o exitCondition()
Returns the exit condition of the work item.
 o finish()

This function/method ends the execution of a manual-exit work item (action call).

 o firstNotificationTime()
Returns the time the first notification for the work item is to occur or has occurred.
 o forceFinish()

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).

 o forceRestart()

This function/method forces MQ Workflow to enable the restart of a work item (action call).

 o implementation()
Returns the name of the implementing program of the associated activity instance.
 o inContainer()

This function/method retrieves the input container associated with the work item from the MQ Workflow execution server (action call).

 o manualExitMode()
Returns whether the exit mode of the work item is manual.
 o manualStartMode()
Returns whether the start mode of the work item is manual.
 o outContainer()

This function/method retrieves the output container associated with the work item from the MQ Workflow execution server (action call).

 o priority()
Returns the priority of the work item.
 o restart()

This function/method asks MQ Workflow to enable the restart of a work item (action call).

 o secondNotificationTime()
Returns the time the second notification for the work item is to occur or has occurred.
 o staff()
Returns all persons owning a work item for the associated activity instance.
 o start()

This function/method starts a ready work item (action call).

 o startCondition()
Returns the start condition of the work item.
 o startTool(String)

This function/method starts the specified support tool (action call).

 o state()
Returns the state of the work item.
 o stateOfNotification()
Returns the notification state of the work item.
 o supportTools()
Returns the support tools associated with the work item.
 o terminate()

This function/method terminates a work item implemented by a program or process (action call).

Methods

 o activityKind
 public abstract Type activityKind() throws FmcException
Returns the kind of the associated activity instance, whether it is a program or process and so on.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o errorReason
 public abstract FmcError errorReason() throws FmcException
Returns an error object describing the reason why the associated activity instance is in state InError.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o exitCondition
 public abstract String exitCondition() throws FmcException
Returns the exit condition of the work item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o firstNotificationTime
 public abstract Calendar firstNotificationTime() throws FmcException
Returns the time the first notification for the work item is to occur or has occurred.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o implementation
 public abstract String implementation() throws FmcException
Returns the name of the implementing program of the associated activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o manualExitMode
 public abstract boolean manualExitMode() throws FmcException
Returns whether the exit mode of the work item is manual.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o manualStartMode
 public abstract boolean manualStartMode() throws FmcException
Returns whether the start mode of the work item is manual.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o priority
 public abstract int priority() throws FmcException
Returns the priority of the work item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o secondNotificationTime
 public abstract Calendar secondNotificationTime() throws FmcException
Returns the time the second notification for the work item is to occur or has occurred.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o staff
 public abstract String[] staff() throws FmcException
Returns all persons owning a work item for the associated activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o startCondition
 public abstract String startCondition() throws FmcException
Returns the start condition of the work item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o state
 public abstract ExecutionState state() throws FmcException
Returns the state of the work item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o stateOfNotification
 public abstract Escalation stateOfNotification() throws FmcException
Returns the notification state of the work item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o supportTools
 public abstract String[] supportTools() throws FmcException
Returns the support tools associated with the work item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o cancelCheckOut
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o checkIn
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o checkOut
 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.

ActiveX
WorkitemProgramRetrieval

C-language
FmcjWorkitemProgramRetrieval

C++
FmcjWorkitem::ProgramRetrieval

JAVA
com.ibm.workflow.api.WorkItemPackage.ProgramRetrieval

The enumeration constants can take the following values; it is strongly advised to use the symbolic names instead of the associated integer values.

NotSet
indicates that no value is set.

ActiveX
WIProgramRetrieval_NotSet

C-language
Fmc_WS_NotSet

C++
FmcjWorkitem::NotSet

JAVA
ProgramRetrieval.NOT_SET
CommonDataOnly
returns only data common to all platforms, the description, the icon, the unattended indicator, and the input and output containers. Any platform specification is ignored.

ActiveX
WIProgramRetrieval_CommonDataOnly

C-language
Fmc_WS_CommonDataOnly

C++
FmcjWorkitem::CommonDataOnly

JAVA
ProgramRetrieval.COMMON_DATA_ONLY
SpecifiedDefinitions
returns the program definition for the specified platform. A platform must be specified.

ActiveX
WIProgramRetrieval_SpecifiedDefinitions

C-language
Fmc_WS_SpecifiedDefinitions

C++
FmcjWorkitem::SpecifiedDefinitions

JAVA
ProgramRetrieval.SPECIFIED_DEFINITIONS
AllDefinitions
returns all available program definitions. Any platform specification is ignored.

ActiveX
WIProgramRetrieval_AllDefinitions

C-language
Fmc_WS_AllDefinitions

C++
FmcjWorkitem::AllDefinitions

JAVA
ProgramRetrieval.ALL_DEFINITIONS

The following enumeration types can be used to specify the platform for which program definitions are to be retrieved.

ActiveX
ImplementationDataBasis

C-language
FmcjImplementationDataBasis

C++
FmcjImplementationData::Basis

JAVA
com.ibm.workflow.api.ProgramDataPackage.Basis

The enumeration constants can take the following values; it is strongly advised to use the symbolic names instead of the associated integer values.

NotSet
indicates that no value is set.

ActiveX
Basis_NotSpecified

C-language
Fmc_WS_NotSet

C++
FmcjImplementationData::NotSpecified

JAVA
Basis.NOT_SPECIFIED
OS2
indicates that the program definition for the OS/2 platform is requested.

ActiveX
Basis_OS2

C-language
Fmc_WS_OS2

C++
FmcjImplementationData::OS2

JAVA
Basis.OS2
AIX
indicates that the program definition for the AIX platform is requested.

ActiveX
Basis_AIX

C-language
Fmc_WS_AIX

C++
FmcjImplementationData::AIX

JAVA
Basis.AIX
HPUX
indicates that the program definition for the HP-UX platform is requested.

ActiveX
Basis_HPUX

C-language
Fmc_WS_HPUX

C++
FmcjImplementationData::HPUX

JAVA
Basis.HPUX
Windows95
indicates that the program definition for the Windows 95 platform is requested.

ActiveX
Basis_Windows95

C-language
Fmc_WS_Windows95

C++
FmcjImplementationData::Windows95

JAVA
Basis.WINDOWS_95
WindowsNT
indicates that the program definition for the Windows NT platform is requested.

ActiveX
Basis_WindowsNT

C-language
Fmc_WS_WindowsNT

C++
FmcjImplementationData::WindowsNT

JAVA
Basis.WINDOWS_NT
OS390
indicates that the program definition for the OS/390 platform is requested.

ActiveX
Basis_OS390

C-language
Fmc_WS_OS390

C++
FmcjImplementationData::OS390

JAVA
Basis.WINDOWS_OS390
Solaris
indicates that the program definition for the Solaris platform is requested.

ActiveX
Basis_Solaris

C-language
Fmc_WS_Solaris

C++
FmcjImplementationData::Solaris

JAVA
Basis.Solaris

Throws: FmcException
thrown if an API error or a communication error occurred.
 o checkOut2
 public abstract ProgramData checkOut2(ProgramRetrieval requestedData,
                                       Basis platform) throws FmcException

See checkOut; additionally allows for specifying which program definitions to retrieve.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o finish
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o forceFinish
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o forceRestart
 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.

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 associated with the work item from the MQ Workflow execution server (action call).

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 associated with the work item from the MQ Workflow execution server (action call).

Throws: FmcException
thrown if an API error or a communication error occurred.
 o restart
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o start
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o startTool
 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.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o terminate
 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.

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index