|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public boolean isEmpty() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isComplete() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String category() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar creationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String description() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String documentation() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar endTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String icon() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String inContainerName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public ItemType kind() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar lastModificationTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String name() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String outContainerName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String owner() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String persistentOid() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String persistentOidOfProcessInstance() throws FmcException
of the associated process instance.
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processAdmin() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processInstanceName() throws FmcException
of the process instance the item is part of.
FmcException
- thrown if an API error or a communication error occurred.public ExecutionState processInstanceState() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processInstanceSystemGroupName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String processInstanceSystemName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public AssignReason receivedAs() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar receivedTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.util.Calendar startTime() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.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:
* ? " ; : . $
FmcException
- thrown if an API error or a communication error occurred.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:
FmcException
- thrown if an API error or a communication error occurred.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.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |