Enterprise Information Portal APIs

com.ibm.mm.beans.workflow
Class CMBWorkList

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

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

This class represents a worklist.

See Also:
CMBWorkFlowQueryService, Serialized Form

Constructor Summary
CMBWorkList()
          constructor
 
Method Summary
 java.lang.String getACLName()
          Gets access control list name.
 boolean getCheckOutFlag(boolean checkOutFlag)
          Gets checkOutFlag.
 CMBConnection getConnection()
          Get the reference of connection bean.
 java.lang.String getDescription()
          Gets description.
 java.lang.String getFilter()
          Gets filter name
 java.lang.String getName()
          Gets worklist name.
 java.lang.String getOwner()
          Gets owner of the worklist.
 java.lang.String getSortCriteria()
          Gets sort criteria.
 int getThreshold()
          Gets threshold.
 java.util.Collection getWorkItems()
          Gets a collection of CMBWorkItems for this worklist.
 int getWorkItemsSize()
          Gets the number of work items in this worklist.
 java.util.Collection getWorkNotifications()
          Gets a collection of CMBWorkNotification objects.
 int getWorkNotificationsSize()
          Gets the number of work notifications in this worklist.
 boolean isWorkItemsRetrieved()
          Checks if the work item data has been retrieved
 boolean isWorkNotificationsRetrieved()
          Checks if data has been retrieved
 void setACLName(java.lang.String aclName)
          Sets access control list name.
 void setCheckOutFlag(boolean checkOutFlag)
          Sets checkOutFlag.
 void setConnection(CMBConnection connection)
          Sets connection bean reference.
 void setDescription(java.lang.String description)
          Sets description.
 void setFilter(java.lang.String filter)
          Sets filter name.
 void setName(java.lang.String name)
          Sets worklist name.
 void setOwner(java.lang.String owner)
          Sets owner of the worklist.
 void setSortCriteria(java.lang.String sortCriteria)
          Sets sort criteria.
 void setThreshold(int threshold)
          Sets threshold.
 void setWorkItemsRetrieved(boolean isWorkItemsRetrieved)
          Reset the property value back to not retrieved in order to clear out cache information and retrieve updated data from the server.
 void setWorkNotifications(java.util.Collection workNotificationList)
          Sets a collection of CMBWorkNotification objects.
 void setWorkNotificationsRetrieved(boolean isWorkNotificationsRetrieved)
          Reset the property value back to not retrieved in order to clear out cache information and retrieve updated data from the server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBWorkList

public CMBWorkList()
constructor
Method Detail

getName

public java.lang.String getName()
Gets worklist name.
Returns:
worklist name. A null is returned if name is not set

setName

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

getACLName

public java.lang.String getACLName()
Gets access control list name.
Returns:
access control list name. A null is returned if access control list name is not set

setACLName

public void setACLName(java.lang.String aclName)
Sets access control list name.
Parameters:
aclName - the access control list name

getOwner

public java.lang.String getOwner()
Gets owner of the worklist.
Returns:
worklist owner. A null is returned if owner is not set.

setOwner

public void setOwner(java.lang.String owner)
Sets owner of the worklist.
Parameters:
owner - worklist owner

getThreshold

public int getThreshold()
Gets threshold.
Returns:
worklist threshold

setThreshold

public void setThreshold(int threshold)
Sets threshold.
Parameters:
threshold - worklist threshold

getFilter

public java.lang.String getFilter()
Gets filter name
Returns:
worklist filter name. A null is returned if filter is not set.

setFilter

public void setFilter(java.lang.String filter)
Sets filter name.
Parameters:
filter - worklist filter

getSortCriteria

public java.lang.String getSortCriteria()
Gets sort criteria.
Returns:
worklist sortCriteria. A null is returned if criteria is not set.

setSortCriteria

public void setSortCriteria(java.lang.String sortCriteria)
Sets sort criteria.
Parameters:
sortCriteria - worklist sort criterias

setDescription

public void setDescription(java.lang.String description)
Sets description.
Parameters:
description - the description of this worklists

getDescription

public java.lang.String getDescription()
Gets description.
Returns:
description. A null is returned if description is not set.

getWorkItems

public java.util.Collection getWorkItems()
                                  throws CMBException
Gets a collection of CMBWorkItems for this worklist.
Returns:
a collection of CMBWorkItem objects. A null is returned if work items is not set. The work items are cached, if you want to refresh the cache first call isWorkItemsRetrieved(false) before calling this method.

getWorkNotifications

public java.util.Collection getWorkNotifications()
                                          throws CMBException
Gets a collection of CMBWorkNotification objects.
Returns:
collection of CMBWorkNotification objects. A null is returned if there are no work notifcations. The notifications are cached, if you want to refresh the cache first call isNotificationsRetrieved(false) before calling this method.

getWorkItemsSize

public int getWorkItemsSize()
                     throws CMBException
Gets the number of work items in this worklist. Note: this method must query the workflow server if the work items have not been retrieved.
Returns:
the number of items in this worklist.

getWorkNotificationsSize

public int getWorkNotificationsSize()
                             throws CMBException
Gets the number of work notifications in this worklist. Note: this method must query the workflow server if the notifications have not been retrieved.
Returns:
the number of notifications in this work list.

setWorkNotifications

public void setWorkNotifications(java.util.Collection workNotificationList)
Sets a collection of CMBWorkNotification objects.
Parameters:
workNotificationList - a collection of CMBWorkNotification objects. A null is returned if there are no work notifications.

setCheckOutFlag

public void setCheckOutFlag(boolean checkOutFlag)
Sets checkOutFlag. This value determines if the work items are checked out when retrieved from the server. Default value is true.

getCheckOutFlag

public boolean getCheckOutFlag(boolean checkOutFlag)
Gets checkOutFlag. This value determines if the work items are checked out when retrieved from the server.

setWorkNotificationsRetrieved

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

isWorkNotificationsRetrieved

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

setWorkItemsRetrieved

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

isWorkItemsRetrieved

public boolean isWorkItemsRetrieved()
Checks if the work item data has been retrieved
Returns:
true if retrieved, false otherwise

setConnection

public void setConnection(CMBConnection connection)
Sets connection bean reference.
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.