All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.ActivityInstance
- public interface ActivityInstance
- Version:
- 3.2.0.2
-
activationTime()
- Returns the
activation time of the activity instance.
-
category()
- Returns the process
category of the activity instance.
-
description()
- Returns the description
of the activity instance.
-
documentation()
- Returns the
documentation of the activity instance.
-
endTime()
- Returns the ending time of
the activity instance.
-
errorReason()
- Returns an error object
describing the reason why the activity instance is in state InError.
-
exitCondition()
- Returns the exit
condition of the activity instance.
-
firstNotificationTime()
- Returns the
time the first notification for the activity instance is to occur or has
occurred.
-
firstNotifiedPersons()
- Returns the
persons who received a first notification for the activity instance.
-
fullName()
- Returns the fully qualified
name of the activity instance (dot notation).
-
icon()
- Returns the icon associated
with the activity instance.
-
implementation()
- Returns the name of
the implementing program of the activity instance.
-
inContainerName()
- Returns the name of
the input container of the activity instance.
-
isComplete()
- Indicates whether the
complete activity instance information is available.
-
isEmpty()
- Indicates whether no
activity instance information is available.
-
kind()
- States the kind of the activity
instance, whether it is a program, a process, or a block.
-
lastModificationTime()
- Returns the
last time a primary attribute of the activity instance was changed.
-
lastStateChangeTime()
- Returns the last
time the state of the activity instance changed.
-
manualExitMode()
- Returns whether the
exit mode of the activity instance is manual.
-
manualStartMode()
- Returns whether the
start mode of the activity instance is manual.
-
name()
- Returns the name of the
activity instance.
-
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).
-
outContainerName()
- Returns the name of
the output container of the activity instance.
-
persistentOid()
- Returns a
representation of the object identification of the activity instance.
-
priority()
- Returns the priority of the
activity instance.
-
processAdmin()
- Returns the process
administrator of the activity instance.
-
processInstanceName()
- Returns the name
of the process instance the activity instance is part of.
-
processInstanceState()
- Returns the
state of the process instance the activity instance is part of.
-
processInstanceSystemGroupName()
- Returns
the name of the system group of the process instance the item is part
of.
-
processInstanceSystemName()
- Returns
the name of the system of the process instance the activity instance is part
of.
-
secondNotificationTime()
- Returns the
time the second notification for the activity instance is to occur or has
occurred.
-
secondNotifiedPersons()
- Returns the
persons who received a second notification for the activity instance.
-
staff()
- Returns all persons a work
item for the activity instance has been assigned to.
-
startCondition()
- Returns the start
condition of the activity instance.
-
starter()
- Returns the starter of the
activity instance.
-
startTime()
- Returns the start time of
the activity instance.
-
state()
- Returns the state of the
activity instance.
-
stateOfNotification()
- Returns the
notification state of the activity instance.
-
subProcessInstance()
-
This function/method retrieves the process instance which is implementing
the activity instance from the MQ Workflow execution server (action
call).
-
supportTools()
- Returns the support
tools associated with the activity instance.
-
symbolLayout()
- Returns the symbol
layout of the activity instance.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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