All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.workflow.api.Item

public interface Item
Version:
3.2.0.2

Method Index

 o category()
Returns the process category of the item.
 o creationTime()
Returns the creation time of the item.
 o delete()

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

 o description()
Returns the description of the item.
 o documentation()
Returns the documentation of the item.
 o endTime()
Returns the ending time of the item.
 o icon()
Returns the icon associated with the item.
 o inContainerName()
Returns the name of the input container of the item.
 o isComplete()
Indicates whether the complete item information is available.
 o isEmpty()
Indicates whether no item information is available.
 o kind()
States the actual kind of the item, whether it is a work item or some kind of notification.
 o lastModificationTime()
Returns the last time a primary attribute of the item was changed.
 o name()
Returns the name of the item.
 o obtainProcessInstanceMonitor(boolean)

This function/method retrieves the process instance monitor for the process instance the item is part of from the MQ Workflow execution server (action call).

 o outContainerName()
Returns the name of the output container of the item.
 o owner()
Returns the user ID of the owner of the item.
 o persistentOid()
Returns a representation of the object identification of the item.
 o processAdmin()
Returns the user ID of the process administrator of the item.
 o processInstance()

This function/method retrieves the process instance the item is a part of from the MQ Workflow execution server (action call).

 o processInstanceName()
Returns the name of the process instance the item is part of.
 o processInstanceState()
Returns the state of the process instance the item is part of.
 o processInstanceSystemGroupName()
Returns the name of the system group of the process instance the item is part of.
 o processInstanceSystemName()
Returns the name of the system of the process instance the item is part of.
 o receivedAs()
Returns the reason why the item was received.
 o receivedTime()
Returns the time when the item was received.
 o refresh()

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

 o setDescription(String)

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

 o setName(String)

This function/method sets the name of the item (action call).

 o startTime()
Returns the start time of the item.
 o transfer(String)

This function/method transfers an item to the specified user (action call).

Methods

 o isEmpty
 public abstract boolean isEmpty() throws FmcException
Indicates whether no item 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 item information is available.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o category
 public abstract String category() throws FmcException
Returns the process category of the item.

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 item.

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 item.

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 item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o endTime
 public abstract Calendar endTime() throws FmcException
Returns the ending time of the item.

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 item.

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 item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o kind
 public abstract ItemType kind() throws FmcException
States the actual kind of the item, whether it is a work item or some kind of notification.

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 item 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 item. In the C-language, a work item or activity instance notification requires a buffer of at least 33 bytes, a process instance notification a buffer of at least 64 bytes.

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 item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o owner
 public abstract String owner() throws FmcException
Returns the user ID of the owner of the item.

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 item.

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 item.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processInstanceName
 public abstract String processInstanceName() throws FmcException
Returns the name of the process instance the item is part of.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o processInstanceState
 public abstract ExecutionState processInstanceState() throws FmcException
Returns the state of the process instance the item is part of.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o 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.
 o processInstanceSystemName
 public abstract String processInstanceSystemName() throws FmcException
Returns the name of the system of the process instance the item is part of.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o receivedAs
 public abstract AssignReason receivedAs() throws FmcException
Returns the reason why the item was received.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o receivedTime
 public abstract Calendar receivedTime() throws FmcException
Returns the time when the item was received.

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 item.

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 item from the MQ Workflow execution server (action call).

A notification can always be deleted. A work item must be in states Ready, Finished, ForceFinished, or Disabled. If the work item is in the Ready state and represents the only work associated with the activity instance and when the associated process instance is not Terminating or Terminated, then deletion is rejected.

Throws: FmcException
thrown if an API error or a communication error occurred.
 o obtainProcessInstanceMonitor
 public abstract ProcessInstanceMonitor obtainProcessInstanceMonitor(boolean deep) throws FmcException

This function/method retrieves the process instance monitor for the process instance the item is part of 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 processInstance
 public abstract ProcessInstance processInstance() throws FmcException

This function/method retrieves the process instance the item is a part of 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 refresh
 public abstract void refresh() throws FmcException

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

All information about the item, primary and secondary, is retrieved.

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 item (action call).

If no name is provided, the name of the item is reset to its default, the activity instance respectively the process instance name.

The following rules apply for specifying a work item or activity instance notification name:

The following rules apply for specifying a process instance notification 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 item to the specified value (action call).

If no description is provided, the description of the item is reset to the description of the associated activity instance or process instance.

The following rules apply for specifying an item description:

Throws: FmcException
thrown if an API error or a communication error occurred.
 o transfer
 public abstract void transfer(String userID) throws FmcException

This function/method transfers an item to the specified user (action call).

Notifications can always be transferred. A work item must be in states Ready, InError, Executed, Suspending, or Suspended and the associated process instance in states Running, Suspending, or Suspended.

The user who transfers the item must be the owner of the item or have work item authorization for the owner of the item and have work item authorization for the new owner.

Throws: FmcException
thrown if an API error or a communication error occurred.

All Packages  Class Hierarchy  This Package  Previous  Next  Index