Enterprise Information Portal APIs

com.ibm.mm.beans.workflow
Class CMBWorkItem

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

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

This class represents a work item.

See Also:
CMBWorkFlowQueryService, Serialized Form

Constructor Summary
CMBWorkItem()
          Default constructor
 
Method Summary
 java.lang.String getActivityDescription()
          Gets activity description.
 CMBConnection getConnection()
          Get the reference of connection bean.
 CMBWorkFlowContainer getContainer()
          Gets container.
 java.lang.String getCreationTime()
          Gets creation time.
 java.lang.String getModificationTime()
          Gets modification time.
 java.lang.String getNodeName()
          Gets node name.
 java.lang.String getNotificationTime()
          Gets notification time.
 java.lang.String getOwner()
          Gets work item owner.
 int getPriority()
          Gets priority.
 java.lang.String getStartTime()
          Gets start time.
 int getState()
          Gets work item state.
 java.lang.String getWorkFlowName()
          Gets workflow name.
 boolean isContainerRetrieved()
          Checks if data has been retrieved.
 void setActivityDescription(java.lang.String activityDescription)
          Sets activity description.
 void setConnection(CMBConnection connection)
          Set the reference of connection bean.
 void setContainerRetrieved(boolean isContainerRetrieved)
          Reset the property value back to not retrieved in order to clear out cache information and retrieve updated data from the server.
 void setCreationTime(java.lang.String creationTime)
          Sets creation time.
 void setModificationTime(java.lang.String modificationTime)
          Sets modification time.
 void setNodeName(java.lang.String nodeName)
          Sets node name.
 void setNotificationTime(java.lang.String notificationTime)
          Sets notification time.
 void setOwner(java.lang.String owner)
          Sets work item owner.
 void setPriority(int priority)
          Sets priority.
 void setStartTime(java.lang.String startTime)
          Sets start time.
 void setState(int wiState)
          Sets work item state.
 void setWorkFlowName(java.lang.String workFlowName)
          Sets workflow name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBWorkItem

public CMBWorkItem()
            throws java.lang.Exception
Default constructor
Method Detail

getNodeName

public java.lang.String getNodeName()
Gets node name.
Returns:
work item node name. Null is returned if node name is not set.

setNodeName

public void setNodeName(java.lang.String nodeName)
Sets node name.
Parameters:
nodeName - work item node name.

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 - work item activityDescription.

setOwner

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

getOwner

public java.lang.String getOwner()
Gets work item owner.
Returns:
the owner of this work item. Null is returned if owner is not set.

setWorkFlowName

public void setWorkFlowName(java.lang.String workFlowName)
Sets workflow name.
Parameters:
workFlowName - workflow name

getWorkFlowName

public java.lang.String getWorkFlowName()
Gets workflow name.
Returns:
the workflow name of this work item. Null is returned if workflow name is not set.

getState

public int getState()
Gets work item state.
Returns:
the work item state 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

setState

public void setState(int wiState)
Sets work item state. The work item state is the state of the work item associated with this work item in the workflow system.
Parameters:
wiState - the state of this work item

getPriority

public int getPriority()
Gets priority.
Returns:
the priority of the work item.

setPriority

public void setPriority(int priority)
Sets priority.
Parameters:
priority - the priority of this work item

setCreationTime

public void setCreationTime(java.lang.String creationTime)
Sets creation time.
Parameters:
creationTime - the time the work item was created. Creation time must be in military time and format: yyyy-mo-dd-hh.mi.ss

getCreationTime

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

setModificationTime

public void setModificationTime(java.lang.String modificationTime)
Sets modification time.
Parameters:
modificationTime - the last time a primary attribute of the work item was changed. Modification time must be in military time and format: yyyy-mo-dd-hh.mi.ss

getModificationTime

public java.lang.String getModificationTime()
Gets modification time. The last time a primary attribute of the work item was changed is returned as a String in military time, format: yyyy-mo-dd-hh.mi.ss
Returns:
modificationTime - a null is returned if the modificationTime is not set

getContainer

public CMBWorkFlowContainer getContainer()
                                  throws CMBException
Gets container.
Returns:
container - null is returned if container is not set. The container is not set because this work item no longer exists in the work flow server. The container is cached, if you want to refresh the cache first call isContainerRetrieved(false) before calling this method.
Note: you must use the CMBWorkFlowDataManagement updateContainer method followed by the checkin() method to update the container in the workflow system.

setContainerRetrieved

public void setContainerRetrieved(boolean isContainerRetrieved)
Reset the property value back to not retrieved in order to clear out cache information and retrieve updated data from the server.
Parameters:
isContainerRetrieved - false if want to retrieve fresh data from server.

isContainerRetrieved

public boolean isContainerRetrieved()
Checks if data has been retrieved.
Returns:
true if retrieved, false otherwise

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. Null is returned if the notifiationTime 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 - the notification time

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:
the start time of this work item. 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 - the start time of this work item

setConnection

public void setConnection(CMBConnection connection)
Set the reference of connection bean.
Parameters:
conn - reference of connection bean

getConnection

public CMBConnection getConnection()
Get the reference of connection bean.

EIP JavaBeans

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