All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.ProcessInstance
- public interface ProcessInstance
- Version:
- 3.2.0.2
-
auditMode()
- Returns the audit mode of
the process instance.
-
category()
- Returns the category of the
process instance.
-
creationTime()
- Returns the creation
time of the process instance.
-
creator()
- Returns the creator of the
process instance.
-
delete()
-
This function/method deletes the specified process instance from the MQ
Workflow execution server (action call).
-
description()
- Returns the description
of the process instance.
-
documentation()
- Returns the
documentation of the process instance.
-
endTime()
- Returns the end time of the
process instance.
-
icon()
- Returns the icon associated with
the process instance.
-
inContainer()
-
This function/method retrieves the input container associated with the
process instance from the MQ Workflow execution server (action
call).
-
inContainerName()
- Returns the name of
the input container of the process instance.
-
inContainerNeeded()
- Indicates whether
an input container is needed to start the process instance.
-
isComplete()
- Indicates whether the
complete process instance information is available.
-
isEmpty()
- Indicates whether no process
instance information is available.
-
lastModificationTime()
- Returns the last
time a primary attribute of the process instance was changed.
-
lastStateChangeTime()
- Returns the last
time the state of the process instance was changed.
-
name()
- Returns the name of the process
instance.
-
notificationTime()
-
-
notifiedPerson()
- Returns the person who
received the notification.
-
obtainMonitor(boolean)
-
This function/method obtains a monitor for the process instance from the MQ
Workflow execution server (action call).
-
organizationName()
- Returns the name of
the organization of the process instance.
-
outContainerName()
- Returns the name of
the output container of the process instance.
-
parentName()
- Returns the name of the
parent process instance of this process instance.
-
persistentOid()
- Returns a
representation of the object identification of the process instance.
-
processAdmin()
- Returns the user ID of
the process administrator of the process instance.
-
processTemplateName()
- Returns the name
of the process template the process instance is derived from.
-
refresh()
-
This function/method refreshes the process instance from the MQ Workflow
execution server (action call).
-
restart()
-
-
resume(boolean)
-
This function/method resumes processing of a suspended or suspending
process instance (action call).
-
roleName()
- Returns the name of the role
of the process instance.
-
setDescription(String)
-
This function/method sets the description of the process instance to the
specified value (action call).
-
setName(String)
-
This function/method sets the name of the process instance to the specified
value (action call).
-
start()
-
This function/method starts a ready process instance (action call).
-
start2(ReadWriteContainer)
-
See start; additionally allows to pass an input container.
-
starter()
- Returns the starter of the
process instance.
-
startTime()
- Returns the start time of
the process instance.
-
state()
- Returns the state of the
process instance.
-
stateOfNotification()
- Returns the
notification state of the process instance.
-
suspend(boolean)
-
This function/method suspends (temporarily stops) the process instance
(action call).
-
suspend2(Calendar, boolean)
-
See suspend; additionally allows to provide a date at which the process
instance is automatically resumed.
-
suspensionExpirationTime()
- Returns the
suspension expiration time of the process instance.
-
suspensionTime()
- Returns the time the
process instance was suspended.
-
systemGroupName()
- Returns the name of
the system group where the process instance runs.
-
systemName()
- Returns the name of the
system where the process instance runs.
-
terminate()
-
This function/method terminates a process instance and all of its
non-autonomous subprocesses (action call).
-
topLevelName()
- Returns the name of the
top level process instance of this process instance.
isEmpty
public abstract boolean isEmpty() throws FmcException
- Indicates whether no process
instance information is available.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
isComplete
public abstract boolean isComplete() throws FmcException
- Indicates whether the
complete process instance information is available.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
auditMode
public abstract AuditSetting auditMode() throws FmcException
- Returns the audit mode of
the process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
category
public abstract String category() throws FmcException
- Returns the category of the
process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
creationTime
public abstract Calendar creationTime() throws FmcException
- Returns the creation
time of the process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
creator
public abstract String creator() throws FmcException
- Returns the creator of the
process 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 process 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 process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
endTime
public abstract Calendar endTime() throws FmcException
- Returns the end time of the
process instance.
- 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 process 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 process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
inContainerNeeded
public abstract boolean inContainerNeeded() throws FmcException
- Indicates whether
an input container is needed to start the process 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 process 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 process instance was changed.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
name
public abstract String name() throws FmcException
- Returns the name of the process
instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
notificationTime
public abstract Calendar notificationTime() throws FmcException
notifiedPerson
public abstract String notifiedPerson() throws FmcException
- Returns the person who
received the notification.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
organizationName
public abstract String organizationName() throws FmcException
- Returns the name of
the organization of the process 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 process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
parentName
public abstract String parentName() throws FmcException
- Returns the name of the
parent process instance of this process 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 process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
processAdmin
public abstract String processAdmin() throws FmcException
- Returns the user ID of
the process administrator of the process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
processTemplateName
public abstract String processTemplateName() throws FmcException
- Returns the name
of the process template the process instance is derived from.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
roleName
public abstract String roleName() throws FmcException
- Returns the name of the role
of the process 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
process 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 process 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
process 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 process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
suspensionExpirationTime
public abstract Calendar suspensionExpirationTime() throws FmcException
- Returns the
suspension expiration time of the process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
suspensionTime
public abstract Calendar suspensionTime() throws FmcException
- Returns the time the
process instance was suspended.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
systemGroupName
public abstract String systemGroupName() throws FmcException
- Returns the name of
the system group where the process instance runs.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
systemName
public abstract String systemName() throws FmcException
- Returns the name of the
system where the process instance runs.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
topLevelName
public abstract String topLevelName() throws FmcException
- Returns the name of the
top level process instance of this process instance.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
delete
public abstract void delete() throws FmcException
-
This function/method deletes the specified process instance from the MQ
Workflow execution server (action call).
The process instance must be a top-level process and in states
Ready, Finished, or Terminated. The
creator can delete the process instance as long as it has not been
started.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
inContainer
public abstract ReadWriteContainer inContainer() throws FmcException
-
This function/method retrieves the input container associated with the
process instance from the MQ Workflow execution server (action
call).
- Throws: FmcException
- thrown if an API error or a communication error occurred.
obtainMonitor
public abstract ProcessInstanceMonitor obtainMonitor(boolean deep) throws FmcException
-
This function/method obtains a monitor for the process instance from the MQ
Workflow execution server (action call).
When the deep option is specified, then 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.
refresh
public abstract void refresh() throws FmcException
-
This function/method refreshes the process 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.
restart
public abstract void restart() throws FmcException
resume
public abstract void resume(boolean deep) throws FmcException
-
This function/method resumes processing of a suspended or suspending
process instance (action call).
All non-autonomous subprocesses with respect to control autonomy are also resumed, if the deep option is true.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
setName
public abstract void setName(String name) throws FmcException
-
This function/method sets the name of the process instance to the specified
value (action call).
The process instance must still be in the Ready state.
The following rules apply for specifying a process instance name:
- You can specify a maximum of 63 characters.
- You can use any printable characters depending on your current locale,
except the following:
* ? " ; : . $
- You can use blanks with these restrictions: no leading blanks, no
trailing blanks, and no consecutive blanks.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
setDescription
public abstract void setDescription(String description) throws FmcException
-
This function/method sets the description of the process instance to the
specified value (action call).
If no description is provided, the description of the process instance is
erased.
The following rules apply for specifying a process instance
description:
- You can specify a maximum of 254 characters.
- You can use any printable characters depending on your current locale,
including the end-of-line and new-line characters.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
start
public abstract void start() throws FmcException
-
This function/method starts a ready process instance (action call).
When successfully executed, the starter is set to the requestor of this
action and the process administrator is determined.
When initial values are to be passed to the process instance to be started,
an input container can be provided (see also FmcjProcessInstance::
InContainer()). When the process instance requires input and is started
without specifying an input container, the input-container values are not
set. So, when, for example, input-container values are queried from
within an activity implementation, FMC_ERROR_MEMBER_NOT_SET is
returned.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
start2
public abstract void start2(ReadWriteContainer input) throws FmcException
-
See start; additionally allows to pass an input container.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
suspend
public abstract void suspend(boolean deep) throws FmcException
-
This function/method suspends (temporarily stops) the process instance
(action call).
The process instance must be in state Running. All
non-autonomous subprocesses with respect to control autonomy are also suspended if the deep option is true. Autonomous
subprocesses are not considered.
The process instance remains in state Suspending as long as
there are running program activity implementations or suspending
non-autonomous subprocesses. When the activity implementations
completed their executions and when the non-autonomous subprocesses reached
the Suspended state, the process instance is put into the
Suspended state.
Optionally, a date may be specified up to when the process instance is
suspended; it is then automatically resumed, together with the non-autonomous
subprocesses, if the deep option had been specified.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
suspend2
public abstract void suspend2(Calendar time,
boolean deep) throws FmcException
-
See suspend; additionally allows to provide a date at which the process
instance is automatically resumed.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
terminate
public abstract void terminate() throws FmcException
-
This function/method terminates a process instance and all of its
non-autonomous subprocesses (action call).
The process instance must be in states Running,
Suspended, or Suspending.
The process instance is put into state terminating as long as there are
running activity implementations or terminating non-autonomous
subprocesses. When the activity implementations completed their
executions or when the non-autonomous subprocesses terminated, the process
instance is put into the Terminated state. When the process
instance has reached the Terminated state, it is deleted depending
on the setting of the "delete finished items" option.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
All Packages Class Hierarchy This Package Previous Next Index