All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.ActivityInstanceNotification

public interface ActivityInstanceNotification
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 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 associated activity instance.
 o expired()
Returns whether the associated activity instance has been started and is expired now.
 o firstNotificationTime()
Returns the first notification time of the activity instance, that is, the time when this notification has been created.
 o implementation()
Returns the implementing program or process name of the associated activity instance.
 o manualExitMode()
Returns whether the exit mode of the associated activity instance is manual.
 o manualStartMode()
Returns whether the start mode of the associated activity instance is manual.
 o priority()
Returns the priority of the associated activity instance.
 o secondNotificationTime()
Returns the second notification time of the associated activity instance.
 o staff()
Returns all persons owning a work item for the associated activity instance.
 o startCondition()
Returns the start condition of the associated activity instance.
 o startOverdue()
Returns whether the start of the associated activity instance is overdue.
 o startTool(String)

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

 o state()
Returns the state of the associated activity instance.
 o stateOfNotification()
Returns the notification state of the associated activity instance.
 o supportTools()
Returns the support tools associated with the activity instance.

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 associated activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o expired
 public abstract boolean expired() throws FmcException
Returns whether the associated activity instance has been started and is expired now.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o firstNotificationTime
 public abstract Calendar firstNotificationTime() throws FmcException
Returns the first notification time of the activity instance, that is, the time when this notification has been created.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o implementation
 public abstract String implementation() throws FmcException
Returns the implementing program or process name 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 associated activity instance 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 associated activity instance 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 associated activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o secondNotificationTime
 public abstract Calendar secondNotificationTime() throws FmcException
Returns the second notification time of the associated activity instance.

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 associated activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o startOverdue
 public abstract boolean startOverdue() throws FmcException
Returns whether the start of the associated activity instance is overdue.

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 associated activity instance.

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 associated activity instance.

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 activity instance.

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 notification has been created for. 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.

All Packages  Class Hierarchy  This Package  Previous  Next  Index