com.ibm.workflow.api
Interface ActivityInstanceNotification

All Superinterfaces:
Item

public interface ActivityInstanceNotification
extends Item


Method Summary
 ActivityInstance activityInstance()
          This API call retrieves the activity instance the activity instance notification is associated to from the MQ Workflow execution server (action call).
 Type activityKind()
          Returns the kind of the associated activity instance, whether it is a program or process and so on.
 FmcError errorReason()
          Returns an error object describing the reason
 java.lang.String exitCondition()
          Returns the exit condition of the associated activity instance.
 java.util.Calendar expirationTime()
          Returns the expiration time of the associated activity instance.
 java.util.Calendar firstNotificationTime()
          Returns the first notification time of the activity instance, that is, the time when this notification has been created.
 java.lang.String implementation()
          Returns the implementing program or process name of the associated activity instance.
 boolean manualExitMode()
          Returns whether the exit mode of the associated activity instance is manual.
 boolean manualStartMode()
          Returns whether the start mode of the associated activity instance is manual.
 java.lang.String persistentOidOfActivityInstance()
          Returns the object ID of the associated activity instance.
 int priority()
          Returns the priority of the associated activity instance.
 java.util.Calendar secondNotificationTime()
          Returns the second notification time of the associated activity instance.
 java.lang.String[] staff()
          Returns all persons owning a work item for the associated activity instance.
 java.lang.String startCondition()
          Returns the start condition of the associated activity instance.
 void startTool(java.lang.String toolName)
          This API call starts the specified support tool (action call).
 ExecutionState state()
          Returns the state of the associated activity instance.
 Escalation stateOfNotification()
          Returns the notification state of the associated activity instance.
 java.lang.String[] supportTools()
          Returns the support tools associated with the activity instance.
 
Methods inherited from interface com.ibm.workflow.api.Item
category, creationTime, delete, description, documentation, endTime, icon, inContainerName, isComplete, isEmpty, kind, lastModificationTime, name, obtainProcessMonitor, outContainerName, owner, persistentOid, persistentOidOfProcessInstance, processAdmin, processInstance, processInstanceName, processInstanceState, processInstanceSystemGroupName, processInstanceSystemName, receivedAs, receivedTime, refresh, setDescription, setName, startTime, transfer
 

Method Detail

activityKind

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

errorReason

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

exitCondition

public java.lang.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.

expirationTime

public java.util.Calendar expirationTime()
                                  throws FmcException
Returns the expiration time of the associated activity instance.

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

firstNotificationTime

public java.util.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.

implementation

public java.lang.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.

manualExitMode

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

manualStartMode

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

persistentOidOfActivityInstance

public java.lang.String persistentOidOfActivityInstance()
                                                 throws FmcException
Returns the object ID of the associated activity instance.

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

priority

public int priority()
             throws FmcException
Returns the priority of the associated activity instance.

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

secondNotificationTime

public java.util.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.

staff

public java.lang.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.

startCondition

public java.lang.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.

state

public ExecutionState state()
                     throws FmcException
Returns the state of the associated activity instance.

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

stateOfNotification

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

supportTools

public java.lang.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.

activityInstance

public ActivityInstance activityInstance()
                                  throws FmcException

This API call retrieves the activity instance the activity instance notification is associated to from the MQ Workflow execution server (action call).

All information about the activity instance, primary and secondary, is retrieved.

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

startTool

public void startTool(java.lang.String toolName)
               throws FmcException

This API call 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.


© Copyright IBM Corporation 1999, 2007. All Rights Reserved.