com.ibm.workflow.api
Interface Item

All Known Subinterfaces:
ActivityInstanceNotification, ProcessInstanceNotification, WorkItem

public interface Item


Method Summary
 java.lang.String category()
          Returns the process category of the item.
 java.util.Calendar creationTime()
          Returns the creation time
 void delete()
          This API call deletes the specified item from the MQ Workflow execution server (action call).
 java.lang.String description()
          Returns the description of the item.
 java.lang.String documentation()
          Returns the documentation of the item.
 java.util.Calendar endTime()
          Returns the ending time of the item.
 java.lang.String icon()
          Returns the icon associated with the item.
 java.lang.String inContainerName()
          Returns the name of the input container
 boolean isComplete()
          Indicates whether the complete item information is available.
 boolean isEmpty()
          Indicates whether no item information is available.
 ItemType kind()
          States the actual kind of the item, whether it is a work item or some kind of notification.
 java.util.Calendar lastModificationTime()
          Returns the last time a primary attribute of the item was changed.
 java.lang.String name()
          Returns the name of the item.
 InstanceMonitor obtainProcessMonitor(boolean deep)
          This API call retrieves the instance monitor for the process instance the item is part of from the MQ Workflow execution server (action call).
 java.lang.String outContainerName()
          Returns the name of the output container of the item.
 java.lang.String owner()
          Returns the user ID of the owner of the item.
 java.lang.String persistentOid()
          Returns a representation of the object identification of the item.
 java.lang.String persistentOidOfProcessInstance()
          Returns the object ID
 java.lang.String processAdmin()
          Returns the user ID of the process administrator
 ProcessInstance processInstance()
          This API call retrieves the process instance the item is a part of from the MQ Workflow execution server (action call).
 java.lang.String processInstanceName()
          Returns the name
 ExecutionState processInstanceState()
          Returns the state of the process instance the item 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 item is part of.
 AssignReason receivedAs()
          Returns the reason why the item was received.
 java.util.Calendar receivedTime()
          Returns the time when the item was received by the current owner.
 void refresh()
          This API call refreshes the item from the MQ Workflow execution server (action call).
 void setDescription(java.lang.String description)
          This API call sets the description of the item to the specified value (action call).
 void setName(java.lang.String name)
          This API call sets the name of the item (action call).
 java.util.Calendar startTime()
          Returns the start time of the item.
 void transfer(java.lang.String userID)
          This API call transfers an item to the specified user (action call).
 

Method Detail

isEmpty

public boolean isEmpty()
                throws FmcException
Indicates whether no item information is available.

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

isComplete

public boolean isComplete()
                   throws FmcException
Indicates whether the complete item information is available.

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

category

public java.lang.String category()
                          throws FmcException
Returns the process category of the item.

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

creationTime

public java.util.Calendar creationTime()
                                throws FmcException
Returns the creation time

of the item.

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

description

public java.lang.String description()
                             throws FmcException
Returns the description of the item.

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

documentation

public java.lang.String documentation()
                               throws FmcException
Returns the documentation of the item.

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

endTime

public java.util.Calendar endTime()
                           throws FmcException
Returns the ending time of the item.

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

icon

public java.lang.String icon()
                      throws FmcException
Returns the icon associated with the item.

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

inContainerName

public java.lang.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.

kind

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

lastModificationTime

public java.util.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.

name

public java.lang.String name()
                      throws FmcException
Returns the name of the item.

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

outContainerName

public java.lang.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.

owner

public java.lang.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.

persistentOid

public java.lang.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.

persistentOidOfProcessInstance

public java.lang.String persistentOidOfProcessInstance()
                                                throws FmcException
Returns the object ID

of the associated process instance.

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

processAdmin

public java.lang.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.

processInstanceName

public java.lang.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.

processInstanceState

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

processInstanceSystemGroupName

public java.lang.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.

processInstanceSystemName

public java.lang.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.

receivedAs

public AssignReason receivedAs()
                        throws FmcException
Returns the reason why the item was received.

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

receivedTime

public java.util.Calendar receivedTime()
                                throws FmcException
Returns the time when the item was received by the current owner.

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

startTime

public java.util.Calendar startTime()
                             throws FmcException
Returns the start time of the item.

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

delete

public void delete()
            throws FmcException

This API call 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.

obtainProcessMonitor

public InstanceMonitor obtainProcessMonitor(boolean deep)
                                     throws FmcException

This API call retrieves the 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 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.

processInstance

public ProcessInstance processInstance()
                                throws FmcException

This API call 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.

refresh

public void refresh()
             throws FmcException

This API call 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.

setName

public void setName(java.lang.String name)
             throws FmcException

This API call 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.

setDescription

public void setDescription(java.lang.String description)
                    throws FmcException

This API call 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.

transfer

public void transfer(java.lang.String userID)
              throws FmcException

This API call 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, Suspended, or Terminated and the associated process instance in states Running, Suspending, Suspended, or Terminating. Work items in states InError or Terminated can only be transferred to the process administrator. A work item implemented by a process can also be transferred if it is in the Running state.

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.


© Copyright IBM Corporation 1999, 2008. All Rights Reserved.