All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.Item
- public interface Item
- Version:
- 3.2.0.2
-
category()
- Returns the process category of the
item.
-
creationTime()
- Returns the creation time of the
item.
-
delete()
-
This function/method deletes the specified item from the MQ Workflow
execution server (action call).
-
description()
- Returns the description of the
item.
-
documentation()
- Returns the documentation of the
item.
-
endTime()
- Returns the ending time of the
item.
-
icon()
- Returns the icon associated with the
item.
-
inContainerName()
- Returns the name of the input
container of the item.
-
isComplete()
- Indicates whether the complete item
information is available.
-
isEmpty()
- Indicates whether no item information is
available.
-
kind()
- States the actual kind of the item, whether
it is a work item or some kind of notification.
-
lastModificationTime()
- Returns the last time a
primary attribute of the item was changed.
-
name()
- Returns the name of the item.
-
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).
-
outContainerName()
- Returns the name of the output
container of the item.
-
owner()
- Returns the user ID of the owner of the
item.
-
persistentOid()
- Returns a representation of the
object identification of the item.
-
processAdmin()
- Returns the user ID of the process
administrator of the item.
-
processInstance()
-
This function/method retrieves the process instance the item is a part of
from the MQ Workflow execution server (action call).
-
processInstanceName()
- Returns the name of the
process instance the item is part of.
-
processInstanceState()
- Returns the state of the
process instance the item is part of.
-
processInstanceSystemGroupName()
- Returns the name
of the system group of the process instance the item is part of.
-
processInstanceSystemName()
- Returns the name of
the system of the process instance the item is part of.
-
receivedAs()
- Returns the reason why the item was
received.
-
receivedTime()
- Returns the time when the item was
received.
-
refresh()
-
This function/method refreshes the item from the MQ Workflow execution
server (action call).
-
setDescription(String)
-
This function/method sets the description of the item to the specified
value (action call).
-
setName(String)
-
This function/method sets the name of the item (action call).
-
startTime()
- Returns the start time of the
item.
-
transfer(String)
-
This function/method transfers an item to the specified user (action
call).
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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:
- 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 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:
- 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.
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