Enterprise Information Portal APIs

com.ibm.mm.beans.workflow
Class CMBWorkNotification

java.lang.Object
  |
  +--com.ibm.mm.beans.workflow.CMBWorkNotification
All Implemented Interfaces:
java.io.Serializable

public class CMBWorkNotification
extends java.lang.Object
implements java.io.Serializable

This class represents a notification.

See Also:
CMBWorkFlowQueryService, Serialized Form

Constructor Summary
CMBWorkNotification()
          Default constructor
 
Method Summary
 java.lang.String getActivityDescription()
          Gets activity description.
 java.lang.String getCreationTime()
          Gets creation time.
 java.lang.String getItemId()
          Gets item id.
 java.lang.String getModificationTime()
          Gets the last modification time.
 java.lang.String getName()
          Gets name.
 java.lang.String getNotificationTime()
          Gets notification time.
 java.lang.String getOwner()
          Gets owner.
 int getPriority()
          Gets priority.
 java.lang.String getReceivedTime()
          Gets received time.
 int getReceiveReason()
          Gets receive reason.
 java.lang.String getStartTime()
          Gets start time.
 int getState()
          Gets state.
 int getType()
          Gets notification type.
 java.lang.String getWorkFlowTemplateName()
          Gets workflow template name.
 void setActivityDescription(java.lang.String activityDescription)
          Sets activity description.
 void setCreationTime(java.lang.String creationTime)
          Sets creation time.
 void setItemId(java.lang.String itemId)
          Sets item id.
 void setModificationTime(java.lang.String modificationTime)
          Sets the last modification time.
 void setName(java.lang.String name)
          Sets name.
 void setNotificationTime(java.lang.String notificationTime)
          Sets notification time.
 void setOwner(java.lang.String owner)
          Sets owner.
 void setPriority(int priority)
          Sets priority.
 void setReceivedTime(java.lang.String receivedTime)
          Sets received time.
 void setReceiveReason(int receiveReason)
          Sets receive reason.
 void setStartTime(java.lang.String startTime)
          Sets start time.
 void setState(int state)
          Sets state.
 void setType(int type)
          Sets notification type.
 void setWorkFlowTemplateName(java.lang.String workFlowTemplateName)
          Sets workflow template name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBWorkNotification

public CMBWorkNotification()
Default constructor
Method Detail

getName

public java.lang.String getName()
Gets name.
Returns:
work notification name. Null is returned if name is not set.

setName

public void setName(java.lang.String name)
Sets name.
Parameters:
name - work notification name

getItemId

public java.lang.String getItemId()
Gets item id. The workflow name.
Returns:
work notification unique item id, the workflow name. Null is returned if id is not set.

setItemId

public void setItemId(java.lang.String itemId)
Sets item id.
Parameters:
itemId - work notification item id. The id is the name of the workflow. of the assThis is the workflow name.

setWorkFlowTemplateName

public void setWorkFlowTemplateName(java.lang.String workFlowTemplateName)
Sets workflow template name.
Parameters:
workFlowTemplateName - workflow template name.

getWorkFlowTemplateName

public java.lang.String getWorkFlowTemplateName()
Gets workflow template name.
Returns:
workFlowTemplateName the workflow template name for this notification. Null is returned if the attribute is not set.

getType

public int getType()
Gets notification type. A type can be one of the following:
Returns:
type of the notification

setType

public void setType(int type)
Sets notification type. A type must be one of the following:
Parameters:
type - of the notification

setOwner

public void setOwner(java.lang.String owner)
Sets owner.
Parameters:
owner - notification owner

getOwner

public java.lang.String getOwner()
Gets owner.
Returns:
owner notification owner. Null is returned if notification owner is not set.

getState

public int getState()
Gets state.
Returns:
state of the notification For activity notifications the type attribute is:
  • CMBWorkFlowConstants.CMB_WN_TYPE_FIRSTACTIVITYINSTANCENOTIFICATION
If the notification is an activity notification, the state can be one of the following:
  • CMBWorkFlowConstants.CMB_WI_NOTSET
  • CMBWorkFlowConstants.CMB_WI_READY
  • CMBWorkFlowConstants.CMB_WI_RUNNING
  • CMBWorkFlowConstants.CMB_WI_FINISHED
  • CMBWorkFlowConstants.CMB_WI_TERMINATED
  • CMBWorkFlowConstants.CMB_WI_SUSPENDED
  • CMBWorkFlowConstants.CMB_WI_DISABLED
  • CMBWorkFlowConstants.CMB_WI_CHECKEDOUT
  • CMBWorkFlowConstants.CMB_WI_INERROR
  • CMBWorkFlowConstants.CMB_WI_EXECUTED
  • CMBWorkFlowConstants.CMB_WI_PLANNING
  • CMBWorkFlowConstants.CMB_WI_FORCEFINISHED
  • CMBWorkFlowConstants.CMB_WI_DELETED
  • CMBWorkFlowConstants.CMB_WI_TERMINATING
  • CMBWorkFlowConstants.CMB_WI_SUSPENDING

For process notifications the type attribute is: CMBWorkFlowConstants.CMB_WN_TYPE_PROCESSINSTANCENOTIFICATION If the notification is a process notification, the state can be one of the following:
  • CMBWorkFlowConstants.CMB_WPN_NOTSET
  • CMBWorkFlowConstants.CMB_WPN_READY
  • CMBWorkFlowConstants.CMB_WPN_RUNNING
  • CMBWorkFlowConstants.CMB_WPN_FINISHED
  • CMBWorkFlowConstants.CMB_WPN_TERMINATED
  • CMBWorkFlowConstants.CMB_WPN_SUSPENDED
  • CMBWorkFlowConstants.CMB_WPN_TERMINATING
  • CMBWorkFlowConstants.CMB_WPN_SUSPENDING
  • CMBWorkFlowConstants.CMB_WPN_DELETED

setState

public void setState(int state)
Sets state.
Parameters:
state - state of the notification
Returns:
state of the notification For activity notifications the type attribute is:
  • CMBWorkFlowConstants.CMB_WN_TYPE_FIRSTACTIVITYINSTANCENOTIFICATION
If the notification is an activity notification, the state can be one of the following:
  • CMBWorkFlowConstants.CMB_WI_NOTSET
  • CMBWorkFlowConstants.CMB_WI_READY
  • CMBWorkFlowConstants.CMB_WI_RUNNING
  • CMBWorkFlowConstants.CMB_WI_FINISHED
  • CMBWorkFlowConstants.CMB_WI_TERMINATED
  • CMBWorkFlowConstants.CMB_WI_SUSPENDED
  • CMBWorkFlowConstants.CMB_WI_DISABLED
  • CMBWorkFlowConstants.CMB_WI_CHECKEDOUT
  • CMBWorkFlowConstants.CMB_WI_INERROR
  • CMBWorkFlowConstants.CMB_WI_EXECUTED
  • CMBWorkFlowConstants.CMB_WI_PLANNING
  • CMBWorkFlowConstants.CMB_WI_FORCEFINISHED
  • CMBWorkFlowConstants.CMB_WI_DELETED
  • CMBWorkFlowConstants.CMB_WI_TERMINATING
  • CMBWorkFlowConstants.CMB_WI_SUSPENDING

For process notifications the type attribute is: CMBWorkFlowConstants.CMB_WN_TYPE_PROCESSINSTANCENOTIFICATION If the notification is a process notification, the state can be one of the following:
  • CMBWorkFlowConstants.CMB_WPN_NOTSET
  • CMBWorkFlowConstants.CMB_WPN_READY
  • CMBWorkFlowConstants.CMB_WPN_RUNNING
  • CMBWorkFlowConstants.CMB_WPN_FINISHED
  • CMBWorkFlowConstants.CMB_WPN_TERMINATED
  • CMBWorkFlowConstants.CMB_WPN_SUSPENDED
  • CMBWorkFlowConstants.CMB_WPN_TERMINATING
  • CMBWorkFlowConstants.CMB_WPN_SUSPENDING
  • CMBWorkFlowConstants.CMB_WPN_DELETED

getPriority

public int getPriority()
Gets priority. A process notification has no priority assigned.
Returns:
priority the priority of the notification. A process notification has no priority assigned.

setPriority

public void setPriority(int priority)
Sets priority.
Parameters:
priority - priority of the notification

getNotificationTime

public java.lang.String getNotificationTime()
Gets notification time. Notification time is returned as a String in military time, format: yyyy-mo-dd-hh.mi.ss
Returns:
notification time a null is returned if the notificationTime is not set

setNotificationTime

public void setNotificationTime(java.lang.String notificationTime)
Sets notification time. Notification time must be in military time and format: yyyy-mo-dd-hh.mi.ss
Parameters:
notificationTime - time of the notification

getCreationTime

public java.lang.String getCreationTime()
Gets creation time. Creation time is returned as a String in military time, format: yyyy-mo-dd-hh.mi.ss
Returns:
creation time a null is returned if the creationTime is not set

setCreationTime

public void setCreationTime(java.lang.String creationTime)
Sets creation time. Creation time must be in military time and format: yyyy-mo-dd-hh.mi.ss
Parameters:
creationTime - creation time of this notification

getStartTime

public java.lang.String getStartTime()
Gets start time. Start time is returned as a String in military time, format: yyyy-mo-dd-hh.mi.ss
Returns:
start time a null is returned if the startTime is not set

setStartTime

public void setStartTime(java.lang.String startTime)
Sets start time. Start time must be in military time and format:yyyy-mo-dd-hh.mi.ss
Parameters:
startTime - start time of this notification

getModificationTime

public java.lang.String getModificationTime()
Gets the last modification time. Modification time is returned as a String in military time, format: yyyy-mo-dd-hh.mi.ss
Returns:
modification time a null is returned if the startTime is not set

setModificationTime

public void setModificationTime(java.lang.String modificationTime)
Sets the last modification time. Modification time must be in military time and format: yyyy-mo-dd-hh.mi.ss
Parameters:
modificationTime - the last modification time of this notification

getReceivedTime

public java.lang.String getReceivedTime()
Gets received time. Received time is returned as a String in military time, format: yyyy-mo-dd-hh.mi.ss
Returns:
received time a null is returned if the received time is not set

setReceivedTime

public void setReceivedTime(java.lang.String receivedTime)
Sets received time. Received time must be in military time and format: yyyy-mo-dd-hh.mi.ss
Parameters:
_receivedTime - the received time of this notification

getActivityDescription

public java.lang.String getActivityDescription()
Gets activity description.
Returns:
activity description. Null is returned if activity description is not set.

setActivityDescription

public void setActivityDescription(java.lang.String activityDescription)
Sets activity description.
Parameters:
activityDescription - notification activityDescription.

setReceiveReason

public void setReceiveReason(int receiveReason)
Sets receive reason.
Parameters:
reason - the receive reason for this notification

getReceiveReason

public int getReceiveReason()
Gets receive reason.
Returns:
receive reason

EIP JavaBeans

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