|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKWorkFlowNotificationFed
An object-oriented representation of a notification in the workflow server.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKWorkFlowNotificationFed(dkWorkFlowServiceFed service,
java.lang.String workflow_name,
java.lang.String name,
int type,
java.lang.String owner_name)
Constructs a DKWorkFlowNotificationFed with the specified workflow service, work flow name, notification name, and a notification type. |
Method Summary | |
void |
cancel()
Cancels the notification. |
DKTimestamp |
creationTime()
Returns the creation time of the notification. |
java.lang.String |
description()
Returns the description. |
DKTimestamp |
modifiedTime()
Returns the last modification time of the notification. |
java.lang.String |
name()
Returns the notification name. |
DKTimestamp |
notificationTime()
Returns the notification time. |
java.lang.String |
owner()
Returns the owner of the notification. |
int |
priority()
Returns the priority of the notification. |
DKTimestamp |
receivedTime()
Returns the received time of the notification. |
int |
receiveReason()
Returns the received reason of the notification. |
void |
retrieve()
Retrieves and refreshes the information of the notification. |
DKTimestamp |
startTime()
Returns the start time of the notification. |
int |
state()
Returns the state of the notification. |
void |
transfer(java.lang.String user_id)
Transfers the notification to the specified user ID. |
int |
type()
Returns the type of the notification. |
java.lang.String |
workFlowName()
Returns the workflow name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkFlowNotificationFed(dkWorkFlowServiceFed service, java.lang.String workflow_name, java.lang.String name, int type, java.lang.String owner_name) throws DKException, java.lang.Exception
service
- DKWorkFlowServiceFed object.workflow_name
- name of a workflow.name
- name of a node.type
- type of the notification.owner_name
- name of the ownerMethod Detail |
public java.lang.String name() throws DKException, java.lang.Exception
public java.lang.String description() throws DKException, java.lang.Exception
public int type() throws DKException, java.lang.Exception
public int state() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public java.lang.String workFlowName() throws DKException, java.lang.Exception
public int priority() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public java.lang.String owner() throws DKException, java.lang.Exception
public DKTimestamp startTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public DKTimestamp creationTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public DKTimestamp modifiedTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public DKTimestamp notificationTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public DKTimestamp receivedTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public int receiveReason() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved.public void retrieve() throws DKException, java.lang.Exception
The following code assumes WN is a DKWorkFlowNotificationFed object.
WN.retrieve();
DKUsageError
- if the DKWorkFlowNotificationFed object cannot be retrieved, or
the notification type is invalid.public void transfer(java.lang.String user_id) throws DKException, java.lang.Exception
user_id
- user ID.
The following code assumes WN is a retrieved DKWorkFlowNotificationFed object.
WN.transfer("USERID");
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved,
the transfer operation fails, the workflow notification is not in the correct state,
or the workflow is not in the correct state.public void cancel() throws DKException, java.lang.Exception
The following code assumes WN is a retrieved DKWorkFlowNotificationFed object.
WN.cancel();
DKUsageError
- if the DKWorkFlowNotificationFed object is not retrieved, or
the cancel operation fails.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |