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
-
activityKind()
- Returns the
kind of the associated activity instance, whether it is a program or process
and so on.
-
errorReason()
- Returns an
error object describing the reason why the associated activity instance is in
state InError.
-
exitCondition()
- Returns
the exit condition of the associated activity instance.
-
expired()
- Returns whether
the associated activity instance has been started and is expired now.
-
firstNotificationTime()
- Returns
the first notification time of the activity instance, that is, the time when
this notification has been created.
-
implementation()
- Returns
the implementing program or process name of the associated activity
instance.
-
manualExitMode()
- Returns
whether the exit mode of the associated activity instance is manual.
-
manualStartMode()
- Returns
whether the start mode of the associated activity instance is manual.
-
priority()
- Returns the
priority of the associated activity instance.
-
secondNotificationTime()
- Returns
the second notification time of the associated activity instance.
-
staff()
- Returns all
persons owning a work item for the associated activity instance.
-
startCondition()
- Returns
the start condition of the associated activity instance.
-
startOverdue()
- Returns
whether the start of the associated activity instance is overdue.
-
startTool(String)
-
This function/method starts the specified support tool (action
call).
-
state()
- Returns the state
of the associated activity instance.
-
stateOfNotification()
- Returns
the notification state of the associated activity instance.
-
supportTools()
- Returns the
support tools associated with the activity instance.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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