All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.ActivityInstance

public interface ActivityInstance
Version:
3.2.0.2

Method Index

 o activationTime()
Returns the activation time of the activity instance.
 o category()
Returns the process category of the activity instance.
 o description()
Returns the description of the activity instance.
 o documentation()
Returns the documentation of the activity instance.
 o endTime()
Returns the ending time of the activity instance.
 o errorReason()
Returns an error object describing the reason why the activity instance is in state InError.
 o exitCondition()
Returns the exit condition of the activity instance.
 o firstNotificationTime()
Returns the time the first notification for the activity instance is to occur or has occurred.
 o firstNotifiedPersons()
Returns the persons who received a first notification for the activity instance.
 o fullName()
Returns the fully qualified name of the activity instance (dot notation).
 o icon()
Returns the icon associated with the activity instance.
 o implementation()
Returns the name of the implementing program of the activity instance.
 o inContainerName()
Returns the name of the input container of the activity instance.
 o isComplete()
Indicates whether the complete activity instance information is available.
 o isEmpty()
Indicates whether no activity instance information is available.
 o kind()
States the kind of the activity instance, whether it is a program, a process, or a block.
 o lastModificationTime()
Returns the last time a primary attribute of the activity instance was changed.
 o lastStateChangeTime()
Returns the last time the state of the activity instance changed.
 o manualExitMode()
Returns whether the exit mode of the activity instance is manual.
 o manualStartMode()
Returns whether the start mode of the activity instance is manual.
 o name()
Returns the name of the activity instance.
 o obtainProcessInstanceMonitor(boolean)

This function/method retrieves the process instance monitor for the process instance the activity instance is part of from the MQ Workflow execution server (action call).

 o outContainerName()
Returns the name of the output container of the activity instance.
 o persistentOid()
Returns a representation of the object identification of the activity instance.
 o priority()
Returns the priority of the activity instance.
 o processAdmin()
Returns the process administrator of the activity instance.
 o processInstanceName()
Returns the name of the process instance the activity instance is part of.
 o processInstanceState()
Returns the state of the process instance the activity instance is part of.
 o processInstanceSystemGroupName()
Returns the name of the system group of the process instance the item is part of.
 o processInstanceSystemName()
Returns the name of the system of the process instance the activity instance is part of.
 o secondNotificationTime()
Returns the time the second notification for the activity instance is to occur or has occurred.
 o secondNotifiedPersons()
Returns the persons who received a second notification for the activity instance.
 o staff()
Returns all persons a work item for the activity instance has been assigned to.
 o startCondition()
Returns the start condition of the activity instance.
 o starter()
Returns the starter of the activity instance.
 o startTime()
Returns the start time of the activity instance.
 o state()
Returns the state of the activity instance.
 o stateOfNotification()
Returns the notification state of the activity instance.
 o subProcessInstance()

This function/method retrieves the process instance which is implementing the activity instance from the MQ Workflow execution server (action call).

 o supportTools()
Returns the support tools associated with the activity instance.
 o symbolLayout()
Returns the symbol layout of the activity instance.

Methods

 o isComplete
 public abstract boolean isComplete() throws FmcException
Indicates whether the complete activity instance information is available.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o isEmpty
 public abstract boolean isEmpty() throws FmcException
Indicates whether no activity instance information is available.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o kind
 public abstract Type kind() throws FmcException
States the kind of the activity instance, whether it is a program, a process, or a block.

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o category
 public abstract String category() throws FmcException
Returns the process category of the activity instance.

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

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

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

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

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 activity instance is to occur or has occurred.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o firstNotifiedPersons
 public abstract String[] firstNotifiedPersons() throws FmcException
Returns the persons who received a first notification for the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o fullName
 public abstract String fullName() throws FmcException
Returns the fully qualified name of the activity instance (dot notation).

Throws: FmcException
thrown if an API error or a communication error occurred.
 o icon
 public abstract String icon() throws FmcException
Returns the icon associated with the activity instance.

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o inContainerName
 public abstract String inContainerName() throws FmcException
Returns the name of the input container of the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o lastModificationTime
 public abstract Calendar lastModificationTime() throws FmcException
Returns the last time a primary attribute of the activity instance was changed.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o lastStateChangeTime
 public abstract Calendar lastStateChangeTime() throws FmcException
Returns the last time the state of the activity instance changed.

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

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

Throws: FmcException
thrown if an API error or a communication error occurred.
 o outContainerName
 public abstract String outContainerName() throws FmcException
Returns the name of the output container of the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o persistentOid
 public abstract String persistentOid() throws FmcException
Returns a representation of the object identification of the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o priority
 public abstract Integer priority() throws FmcException
Returns the priority of the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processAdmin
 public abstract String processAdmin() throws FmcException
Returns the process administrator of the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processInstanceName
 public abstract String processInstanceName() throws FmcException
Returns the name of the process instance the activity instance is part of.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processInstanceState
 public abstract ExecutionState processInstanceState() throws FmcException
Returns the state of the process instance the activity instance is part of.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processInstanceSystemGroupName
 public abstract String processInstanceSystemGroupName() throws FmcException
Returns the name of the system group of the process instance the item is part of.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processInstanceSystemName
 public abstract String processInstanceSystemName() throws FmcException
Returns the name of the system of the process instance the activity instance is part of.

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 activity instance is to occur or has occurred.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o secondNotifiedPersons
 public abstract String[] secondNotifiedPersons() throws FmcException
Returns the persons who received a second notification for the 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 a work item for the activity instance has been assigned to.

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

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

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

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 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 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 symbolLayout
 public abstract SymbolLayout symbolLayout() throws FmcException
Returns the symbol layout of the activity instance.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o obtainProcessInstanceMonitor
 public abstract ProcessInstanceMonitor obtainProcessInstanceMonitor(boolean deep) throws FmcException

This function/method retrieves the process instance monitor for the process instance the activity instance is part of from the MQ Workflow execution server (action call).

When the deep option is specified, all activity instances of type Block are resolved, that is, their block instance monitors are also fetched from the server.
Note:Deep is currently not supported.

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

This function/method retrieves the process instance which is implementing the activity instance from the MQ Workflow execution server (action call).

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

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index