Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkListICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkListICM
All Implemented Interfaces:
java.io.Serializable

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

The DKWorkListICM class represents a worklist in Content Manager and is used to provide all the functionality related to work list management. A worklist consists of one or more work nodes. A user can query the work packages at these work nodes, or retrieve the next work package from the work list. The order of the work packages in the work list can be specified by priority, time, and order of work nodes in the work list. Furthermore, the results may be filtered to include or exclude suspended work, or include work that is in "notify" state (when a work package has been at a work node for longer than the time specified by the administrator, it is considered to be in "notify" state). Other properties of work lists are: A work node may be in more than one work list at any time. The number of work packages returned in a work list is defined by the system administrator. There can be one or more work lists defined in the system at any given time.

See Also:
DKWorkNodeICM, DKWorkPackageICM, Serialized Form

Constructor Summary
DKWorkListICM()
          Default constructor for the work list object.
 
Method Summary
 java.lang.String getACLName()
          Retrieves the name of the ACL associated with this work list.
 java.lang.String getDescription()
          Retrieves the description for this work list.
 int getMaxResult()
          Retrieves the max result of the workpackages that will be returned from this work list
 java.lang.String getName()
          Retrieves the name of this work list object.
 java.lang.String getPidString()
          Retrieves the persistent identifier (pid) for this work list
 int getSelectionFilterOnNotify()
          Gets the selection filter on notify for this work list.
 int getSelectionFilterOnOwner()
          Retrieves the selection filter on owner value for this work list.
 int getSelectionFilterOnSuspend()
          Retrieves the selection filter on suspend value for this work list.
 int getSelectionOrder()
          Retrieves the selection order for this work list.
 java.lang.String[] getWorkNodeNames()
          Retrieves the work node names for this work list.
 void setACLName(java.lang.String aclName)
          Sets the name of the ACL associated with this work list.
 void setDescription(java.lang.String desc)
          Sets the description for this work list .
 void setMaxResult(int maxResult)
          Sets the max result of workpackages that will be returned from this work list
 void setName(java.lang.String name)
          Sets the name for this work list object.
 void setPidString(java.lang.String pidString)
          Sets the persistent identifier (pid) for this work list.
 void setSelectionFilterOnNotify(int selectionFilter)
          Sets the value for the selection filter on notify for this work list.
 void setSelectionFilterOnOwner(int selectionFilter)
          Sets the selection filter on owner value for this work list.
 void setSelectionFilterOnSuspend(int selectionFilter)
          Sets the value for the selection filter on suspend for this work list.
 void setSelectionOrder(int selectionOrder)
          Sets the selection order for this work list.
 void setWorkNodeNames(java.lang.String[] workNodeNames)
          Sets the names for all the work nodes in this work list.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkListICM

public DKWorkListICM()
Default constructor for the work list object. Constructs and initializes a work list instance.

  DKWorkListICM wl = new DKWorkListICM();
  
Method Detail

getName

public java.lang.String getName()
Retrieves the name of this work list object.
Returns:
the name of this work list as a string

setName

public void setName(java.lang.String name)
Sets the name for this work list object.
Parameters:
name - the new name for this work list

getDescription

public java.lang.String getDescription()
Retrieves the description for this work list.
Returns:
the new description for this work list

setDescription

public void setDescription(java.lang.String desc)
Sets the description for this work list .
Parameters:
desc - the new description for this work list.

getACLName

public java.lang.String getACLName()
Retrieves the name of the ACL associated with this work list.
Returns:
the ACL name for this work list

setACLName

public void setACLName(java.lang.String aclName)
Sets the name of the ACL associated with this work list.
Parameters:
aclName - the name for the new ACL associated with this work list

getWorkNodeNames

public java.lang.String[] getWorkNodeNames()
Retrieves the work node names for this work list.
Returns:
the WorkNodes of the WorkList

setWorkNodeNames

public void setWorkNodeNames(java.lang.String[] workNodeNames)
Sets the names for all the work nodes in this work list.
Parameters:
workNodeNames - array of work node names for this work list

setSelectionOrder

public void setSelectionOrder(int selectionOrder)
Sets the selection order for this work list. If the selectionOrder parameter is set to DK_ICM_DR_SELECTION_ORDER_PRIORITY, the work packages are returned from the work list sorted by their priority. If the selectionOrder parameter is set to DK_ICM_DR_SELECTION_ORDER_TIME, the work packages are returned sorted by date.
Parameters:
selectionOrder - selection order for this work list. Valid values are by priority : DK_ICM_DR_SELECTION_ORDER_PRIORITY or by date : DK_ICM_DR_SELECTION_ORDER_TIME

getSelectionOrder

public int getSelectionOrder()
Retrieves the selection order for this work list. Valid return values are DK_ICM_DR_SELECTION_ORDER_PRIORITY (sort by priority) or DK_ICM_DR_SELECTION_ORDER_TIME(sort by date).
Returns:
the selection order for this work list.

setSelectionFilterOnSuspend

public void setSelectionFilterOnSuspend(int selectionFilter)
                                 throws DKException
Sets the value for the selection filter on suspend for this work list.
Parameters:
selectionFilter - the selection filter on suspend for this work list. Valid values are: DK_ICM_DR_SELECTION_FILTER_NO - workpackages returned from this worklist do not have the suspend flag turned on. DK_ICM_DR_SELECTION_FILTER_YES - workpackages returned from this worklist have the suspend flag turned on. DK_ICM_DR_SELECTION_FILTER_EITHER - workpackages returned from this worklist are not filtered by their suspend flag.
Throws:
DKException - when the parameter selectionFilter is not equal to DK_ICM_DR_SELECTION_FILTER_NO or DK_ICM_DR_SELECTION_FILTER_YES or DK_ICM_DR_SELECTION_FILTER_EITHER

getSelectionFilterOnSuspend

public int getSelectionFilterOnSuspend()
Retrieves the selection filter on suspend value for this work list.
Returns:
the value for the selection filter on suspend for this work list. If selectionFilter is equal to:DK_ICM_DR_SELECTION_FILTER_NO - the workpackages returned from this worklist do not have the suspend flag turned on. If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_YES -the workpackages returned from this worklist have the suspend flag turned on. If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_EITHER - the workpackages returned from this worklist are not filtered by their suspend flag.

setSelectionFilterOnNotify

public void setSelectionFilterOnNotify(int selectionFilter)
                                throws DKException
Sets the value for the selection filter on notify for this work list.
Parameters:
the - selection filter on notify value for this work list If selectionFilter is equal to:DK_ICM_DR_SELECTION_FILTER_NO - the workpackages returned from this worklist do not have the notify flag turned on. If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_YES - the workpackages returned from this worklist have the notify flag turned on. If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_EITHER - the workpackages returned from this worklist are not filtered by their notify flag.
Throws:
DKException - when the parameter selectionFilter is not equal to DK_ICM_DR_SELECTION_FILTER_NO or DK_ICM_DR_SELECTION_FILTER_YES or DK_ICM_DR_SELECTION_FILTER_EITHER

getSelectionFilterOnNotify

public int getSelectionFilterOnNotify()
Gets the selection filter on notify for this work list.
Returns:
the selection filter on notify for this work list If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_NO - the workpackages returned from this worklist do not have the notify flag turned on. If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_YES - the workpackages returned from this worklist have the notify flag turned on. If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_EITHER - the workpackages returned from this worklist are not filtered by their notify flag.

setSelectionFilterOnOwner

public void setSelectionFilterOnOwner(int selectionFilter)
                               throws DKException
Sets the selection filter on owner value for this work list.
Parameters:
the - selection filter on owner value for this work list If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_NO - workpackages from this work list are not filtered by owner If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_YES - workpackages from this work list are filtered by owner
Throws:
DKException - when the parameter selectionFilter is not equal to DK_ICM_DR_SELECTION_FILTER_NO or DK_ICM_DR_SELECTION_FILTER_YES

getSelectionFilterOnOwner

public int getSelectionFilterOnOwner()
Retrieves the selection filter on owner value for this work list.
Returns:
the selection filter on owner value for this work list If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_NO - workpackages from this work list are not filtered by owner If selectionFilter is equal to: DK_ICM_DR_SELECTION_FILTER_YES - workpackages from this work list are filtered by owner

setMaxResult

public void setMaxResult(int maxResult)
Sets the max result of workpackages that will be returned from this work list
Parameters:
maxResult - the maximum result of workpackages that will be returned from this work list Valid values are: 0 - indicates that all work packages should be returned >=1 - indicates that the number of work packages returned should be limited to the value of the parameter

getMaxResult

public int getMaxResult()
Retrieves the max result of the workpackages that will be returned from this work list
Returns:
the max result of workpackages that will be returned from this work list Valid values are: 0 - indicates that all work packages should be returned >=1 - indicates that the number of work packages returned should be limited to the value of the parameter

setPidString

public void setPidString(java.lang.String pidString)
Sets the persistent identifier (pid) for this work list.
Parameters:
the - pid string for this work list

getPidString

public java.lang.String getPidString()
Retrieves the persistent identifier (pid) for this work list
Returns:
the pid string for this work list

EIP Java APIs

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