|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
java.util.Calendar |
activationTime()
Returns the activation time of the activity instance. |
java.lang.String |
category()
Returns the process category of the activity instance. |
java.lang.String |
description()
Returns the description of the activity instance. |
java.lang.String |
documentation()
Returns the documentation of the activity instance. |
java.util.Calendar |
endTime()
Returns the ending time of the activity instance. |
FmcError |
errorReason()
Returns an error object describing the reason why the activity instance is in state InError. |
java.lang.String |
exitCondition()
Returns the exit condition of the activity instance. |
java.util.Calendar |
expirationTime()
Returns the expiration time of the activity instance. |
java.util.Calendar |
firstNotificationTime()
Returns the time the first notification for the activity instance is to occur or has occurred. |
java.lang.String[] |
firstNotifiedPersons()
Returns the persons who received a first notification for the activity instance. |
void |
forceFinish()
This API call ends the execution of the specified activity instance because it is known to have completed (action call). |
void |
forceFinish2(Container outputContainer)
See forceFinish() ; allows for the specification of an output
container. |
void |
forceRestart()
This API call forces MQ Workflow to enable the restart of the specified activity instance (action call). |
void |
forceRestart2(Container inputContainer)
See forceRestart() ; allows for the specification of an input
container. |
java.lang.String |
fullName()
Returns the fully qualified name of the activity instance (dot notation). |
java.lang.String |
icon()
Returns the icon associated with the activity instance. |
java.lang.String |
implementation()
Returns the name of the implementing program of the activity instance. |
ReadOnlyContainer |
inContainer()
This API call retrieves the input container associated with the activity instance from the MQ Workflow execution server (action call). |
java.lang.String |
inContainerName()
Returns the name of the input container of the activity instance. |
boolean |
isComplete()
Indicates whether the complete activity instance information is available. |
boolean |
isEmpty()
Indicates whether no activity instance information is available. |
Type |
kind()
States the kind of the activity instance, whether it is a program, a process, or a block. |
java.util.Calendar |
lastModificationTime()
Returns the last time a primary attribute of the activity instance was changed. |
java.util.Calendar |
lastStateChangeTime()
Returns the last time the state of the activity instance changed. |
boolean |
manualExitMode()
Returns whether the exit mode of the activity instance is manual. |
boolean |
manualStartMode()
Returns whether the start mode of the activity instance is manual. |
java.lang.String |
name()
Returns the name of the activity instance. |
InstanceMonitor |
obtainProcessMonitor(boolean deep)
This API call retrieves a monitor for the process instance the activity instance is part of from the MQ Workflow execution server (action call). |
ReadOnlyContainer |
outContainer()
This API call retrieves the output container associated with the activity instance from the MQ Workflow execution server (action call). |
java.lang.String |
outContainerName()
Returns the name of the output container of the activity instance. |
java.lang.String |
persistentOid()
Returns a representation of the object identification of the activity instance. |
java.lang.Integer |
priority()
Returns the priority of the activity instance. |
java.lang.String |
processAdmin()
Returns the process administrator of the activity instance. |
java.lang.String |
processInstanceName()
Returns the name of the process instance the activity instance is part of. |
ExecutionState |
processInstanceState()
Returns the state of the process instance the activity instance is part of. |
java.lang.String |
processInstanceSystemGroupName()
Returns the name of the system group of the process instance the item is part of. |
java.lang.String |
processInstanceSystemName()
Returns the name of the system of the process instance the activity instance is part of. |
void |
refresh()
This API call refreshes the activity instance from the MQ Workflow execution server (action call). |
java.util.Calendar |
secondNotificationTime()
Returns the time the second notification for the activity instance is to occur or has occurred. |
java.lang.String[] |
secondNotifiedPersons()
Returns the persons |
java.lang.String[] |
staff()
Returns all persons a work item for the activity instance is assigned to. |
java.lang.String |
startCondition()
Returns the start condition of the activity instance. |
java.lang.String |
starter()
Returns the starter of the activity instance or the requestor of a ForceFinish action. |
java.util.Calendar |
startTime()
Returns the start time of the activity instance. |
ExecutionState |
state()
Returns the state of the activity instance. |
Escalation |
stateOfNotification()
Returns the notification state of the activity instance. |
ProcessInstance |
subProcessInstance()
This API call retrieves the process instance which is implementing the activity instance from the MQ Workflow execution server (action call). |
java.lang.String[] |
supportTools()
Returns the support tools associated with the activity instance. |
SymbolLayout |
symbolLayout()
Returns the symbol layout of the activity instance. |
void |
terminate()
This API call terminates an activity instance implemented by a program or process (action call). |
Method Detail |
public boolean isComplete() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isEmpty() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public Type kind() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar activationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String category() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String description() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String documentation() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar endTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public FmcError errorReason() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String exitCondition() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar expirationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar firstNotificationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] firstNotifiedPersons() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String fullName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String icon() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String implementation() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String inContainerName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar lastModificationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar lastStateChangeTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean manualExitMode() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean manualStartMode() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String name() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String outContainerName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String persistentOid() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.Integer priority() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processAdmin() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processInstanceName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ExecutionState processInstanceState() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processInstanceSystemGroupName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processInstanceSystemName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar secondNotificationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] secondNotifiedPersons() throws FmcException
who received a second notification for the activity instance.
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] staff() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String startCondition() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String starter() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar startTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ExecutionState state() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public Escalation stateOfNotification() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] supportTools() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public SymbolLayout symbolLayout() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ReadOnlyContainer inContainer() throws FmcException
This API call retrieves the input container associated with the activity instance from the MQ Workflow execution server (action call).
FmcException
- thrown if an API error or a communication error occurred.public void forceFinish() throws FmcException
This API call ends the execution of the specified activity instance because it is known to have completed (action call).
An activity instance implemented by a program must be in the states Ready, Running, Executed, CheckedOut, InError, Terminating, or Terminated. An activity instance implemented by a process must be in the states Ready, Executed, InError, or Terminated. The associated process instance must be in the states Running, Suspending, Suspended, or Terminating.
Optionally, an output container can be specified to denote the result of processing. If none is specified, the output container available at the execution server is taken. For example, the output container defined with initial values.
The activity instance and, if it exists, the single non-disabled work item are then put into the ForceFinished state. The starter is set to the logged-on user. The exit condition is considered to be true and navigation proceeds.
Depending on the "delete finished items" option, associated work items are deleted.
FmcException
- thrown if an API error or a communication error occurred.public void forceFinish2(Container outputContainer) throws FmcException
forceFinish()
; allows for the specification of an output
container.
FmcException
- thrown if an API error or a communication error occurred.public void forceRestart() throws FmcException
This API call forces MQ Workflow to enable the restart of the specified activity instance (action call).
An activity instance implemented by a program must be in the states Ready, Running, Executed, CheckedOut, InError, Terminating, or Terminated. An activity instance implemented by a process must be in the states Ready, Executed, InError, or Terminated. The associated process instance must be in states Running, Suspending, or Suspended.
Optionally, an input container can be specified to denote the input to be used when the activity instance or its associated work item is (re)started. If none is specified, the input container available at the execution server is taken.
The activity instance and the logged-on user's work item are then reset into the Ready state. If there is no work item for the logged-on user, it is created. All other work items associated with the activity instance are set into the Disabled state. Note that an automatic activity instance must now be started manually.
FmcException
- thrown if an API error or a communication error occurred.public void forceRestart2(Container inputContainer) throws FmcException
forceRestart()
; allows for the specification of an input
container.
FmcException
- thrown if an API error or a communication error occurred.public InstanceMonitor obtainProcessMonitor(boolean deep) throws FmcException
This API call retrieves a 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 monitors are also fetched from the server.
FmcException
- thrown if an API error or a communication error occurred.public ReadOnlyContainer outContainer() throws FmcException
This API call retrieves the output container associated with the activity instance from the MQ Workflow execution server (action call).
FmcException
- thrown if an API error or a communication error occurred.public void refresh() throws FmcException
This API call refreshes the activity instance from the MQ Workflow execution server (action call).
All information about the activity instance, primary and secondary, is retrieved.
FmcException
- thrown if an API error or a communication error occurred.public ProcessInstance subProcessInstance() throws FmcException
This API call 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.
FmcException
- thrown if an API error or a communication error occurred.public void terminate() throws FmcException
This API call terminates an activity instance implemented by a program or process (action call).
If the activity instance is implemented by a program, it must be in the states CheckedOut or Running and the process instance must be in the states Running, Suspending, Suspended, or Terminating. If the activity instance is implemented by a process, it must be in the states Running, Suspending, or Suspended and the process instance must be in the states Running, Suspending, Suspended, or Terminating.
When the activity instance is implemented by a program and processed under the control of a program execution agent or user-defined program execution server, a message is sent to inform about the termination request. The program execution agent tries to kill fenced activity implementations.
An activity instance implemented by a process is terminated together with all its non-autonomous subprocesses with respect to control autonomy.
The activity instance is then put into the Terminating or Terminated state.
When the Terminated state has been reached, the exit condition is considered to be false, the output container and especially the return code (_RC) are not set, and navigation ends. Navigation can be explicitly continued by a user with process administration rights, that is, ForceFinish() or ForceRestart() repair actions can be called.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |