All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.ProcessInstance

public interface ProcessInstance
Version:
3.2.0.2

Method Index

 o auditMode()
Returns the audit mode of the process instance.
 o category()
Returns the category of the process instance.
 o creationTime()
Returns the creation time of the process instance.
 o creator()
Returns the creator of the process instance.
 o delete()

This function/method deletes the specified process instance from the MQ Workflow execution server (action call).

 o description()
Returns the description of the process instance.
 o documentation()
Returns the documentation of the process instance.
 o endTime()
Returns the end time of the process instance.
 o icon()
Returns the icon associated with the process instance.
 o inContainer()

This function/method retrieves the input container associated with the process instance from the MQ Workflow execution server (action call).

 o inContainerName()
Returns the name of the input container of the process instance.
 o inContainerNeeded()
Indicates whether an input container is needed to start the process instance.
 o isComplete()
Indicates whether the complete process instance information is available.
 o isEmpty()
Indicates whether no process instance information is available.
 o lastModificationTime()
Returns the last time a primary attribute of the process instance was changed.
 o lastStateChangeTime()
Returns the last time the state of the process instance was changed.
 o name()
Returns the name of the process instance.
 o notificationTime()
 o notifiedPerson()
Returns the person who received the notification.
 o obtainMonitor(boolean)

This function/method obtains a monitor for the process instance from the MQ Workflow execution server (action call).

 o organizationName()
Returns the name of the organization of the process instance.
 o outContainerName()
Returns the name of the output container of the process instance.
 o parentName()
Returns the name of the parent process instance of this process instance.
 o persistentOid()
Returns a representation of the object identification of the process instance.
 o processAdmin()
Returns the user ID of the process administrator of the process instance.
 o processTemplateName()
Returns the name of the process template the process instance is derived from.
 o refresh()

This function/method refreshes the process instance from the MQ Workflow execution server (action call).

 o restart()
 o resume(boolean)

This function/method resumes processing of a suspended or suspending process instance (action call).

 o roleName()
Returns the name of the role of the process instance.
 o setDescription(String)

This function/method sets the description of the process instance to the specified value (action call).

 o setName(String)

This function/method sets the name of the process instance to the specified value (action call).

 o start()

This function/method starts a ready process instance (action call).

 o start2(ReadWriteContainer)

See start; additionally allows to pass an input container.

 o starter()
Returns the starter of the process instance.
 o startTime()
Returns the start time of the process instance.
 o state()
Returns the state of the process instance.
 o stateOfNotification()
Returns the notification state of the process instance.
 o suspend(boolean)

This function/method suspends (temporarily stops) the process instance (action call).

 o suspend2(Calendar, boolean)

See suspend; additionally allows to provide a date at which the process instance is automatically resumed.

 o suspensionExpirationTime()
Returns the suspension expiration time of the process instance.
 o suspensionTime()
Returns the time the process instance was suspended.
 o systemGroupName()
Returns the name of the system group where the process instance runs.
 o systemName()
Returns the name of the system where the process instance runs.
 o terminate()

This function/method terminates a process instance and all of its non-autonomous subprocesses (action call).

 o topLevelName()
Returns the name of the top level process instance of this process instance.

Methods

 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o notificationTime
 public abstract Calendar notificationTime() throws FmcException
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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.
 o restart
 public abstract void restart() throws FmcException
 o 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.
 o 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:

Throws: FmcException
thrown if an API error or a communication error occurred.
 o 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:

Throws: FmcException
thrown if an API error or a communication error occurred.
 o 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.
 o 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.
 o 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.
 o 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.
 o 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