|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKWorkListICM
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.
DKWorkNodeICM
,
DKWorkPackageICM
, Serialized FormConstructor 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 |
public DKWorkListICM()
DKWorkListICM wl = new DKWorkListICM();
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the new name for this work listpublic java.lang.String getDescription()
public void setDescription(java.lang.String desc)
desc
- the new description for this work list.public java.lang.String getACLName()
public void setACLName(java.lang.String aclName)
aclName
- the name for the new ACL associated with this work listpublic java.lang.String[] getWorkNodeNames()
public void setWorkNodeNames(java.lang.String[] workNodeNames)
workNodeNames
- array of work node names for this work listpublic void setSelectionOrder(int selectionOrder)
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_TIMEpublic int getSelectionOrder()
public void setSelectionFilterOnSuspend(int selectionFilter) throws DKException
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.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_EITHERpublic int getSelectionFilterOnSuspend()
public void setSelectionFilterOnNotify(int selectionFilter) throws DKException
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.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_EITHERpublic int getSelectionFilterOnNotify()
public void setSelectionFilterOnOwner(int selectionFilter) throws DKException
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 ownerDKException
- when the parameter selectionFilter is not equal to DK_ICM_DR_SELECTION_FILTER_NO or
DK_ICM_DR_SELECTION_FILTER_YESpublic int getSelectionFilterOnOwner()
public void setMaxResult(int maxResult)
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 parameterpublic int getMaxResult()
public void setPidString(java.lang.String pidString)
the
- pid string for this work listpublic java.lang.String getPidString()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |