Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowNotificationFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowNotificationFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, java.io.Serializable

public class DKWorkFlowNotificationFed
extends java.lang.Object
implements java.io.Serializable, DKConstantFed, DKMessageIdFed

An object-oriented representation of a notification in the workflow server.

See Also:
Serialized Form

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

DKWorkFlowNotificationFed

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
Constructs a DKWorkFlowNotificationFed with the specified workflow service, work flow name, notification name, and a notification type. A notification type can be one of the following:
Parameters:
service - DKWorkFlowServiceFed object.
workflow_name - name of a workflow.
name - name of a node.
type - type of the notification.
owner_name - name of the owner
Method Detail

name

public java.lang.String name()
                      throws DKException,
                             java.lang.Exception
Returns the notification name.
Returns:
the notification name.

description

public java.lang.String description()
                             throws DKException,
                                    java.lang.Exception
Returns the description.
Returns:
the description.

type

public int type()
         throws DKException,
                java.lang.Exception
Returns the type of the notification. A type can be one of the following:
Returns:
type of the notification.

state

public int state()
          throws DKException,
                 java.lang.Exception
Returns the state of the notification. The state can be in one of the following:
Returns:
state of the notification,
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

workFlowName

public java.lang.String workFlowName()
                              throws DKException,
                                     java.lang.Exception
Returns the workflow name.
Returns:
name of the workflow.

priority

public int priority()
             throws DKException,
                    java.lang.Exception
Returns the priority of the notification. However a process notification has no priority assigned.
Returns:
the priority of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

owner

public java.lang.String owner()
                       throws DKException,
                              java.lang.Exception
Returns the owner of the notification.
Returns:
the owner of the notification.

startTime

public DKTimestamp startTime()
                      throws DKException,
                             java.lang.Exception
Returns the start time of the notification.
Returns:
DKTimestamp object indicating the start time of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

creationTime

public DKTimestamp creationTime()
                         throws DKException,
                                java.lang.Exception
Returns the creation time of the notification.
Returns:
DKTimestamp object indicating the creation time of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

modifiedTime

public DKTimestamp modifiedTime()
                         throws DKException,
                                java.lang.Exception
Returns the last modification time of the notification.
Returns:
DKTimestamp object indicating the modification time of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

notificationTime

public DKTimestamp notificationTime()
                             throws DKException,
                                    java.lang.Exception
Returns the notification time.
Returns:
DKTimestamp object indicating the notification time of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

receivedTime

public DKTimestamp receivedTime()
                         throws DKException,
                                java.lang.Exception
Returns the received time of the notification.
Returns:
DKTimestamp object indicating the received time of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

receiveReason

public int receiveReason()
                  throws DKException,
                         java.lang.Exception
Returns the received reason of the notification. The reason can be one of the following:
Returns:
the received reason of the notification.
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved.

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves and refreshes the information of the notification.

The following code assumes WN is a DKWorkFlowNotificationFed object.

 WN.retrieve();
 
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object cannot be retrieved, or the notification type is invalid.

transfer

public void transfer(java.lang.String user_id)
              throws DKException,
                     java.lang.Exception
Transfers the notification to the specified user ID.
Parameters:
user_id - user ID.

The following code assumes WN is a retrieved DKWorkFlowNotificationFed object.

 WN.transfer("USERID");
 
Throws:
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.

cancel

public void cancel()
            throws DKException,
                   java.lang.Exception
Cancels the notification.

The following code assumes WN is a retrieved DKWorkFlowNotificationFed object.

 WN.cancel();
 
Throws:
DKUsageError - if the DKWorkFlowNotificationFed object is not retrieved, or the cancel operation fails.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.