Enterprise Information Portal APIs

com.ibm.mm.beans.workflow
Class CMBWorkListICM

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

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

This class represents an ICM worklist.

See Also:
CMBDocRoutingQueryService, Serialized Form

Constructor Summary
CMBWorkListICM()
          constructor
 
Method Summary
 java.lang.String getACLName()
          Get acl name.
 CMBConnection getConnection()
          Get the reference of connection bean.
 java.lang.String getDescription()
          Get the description.
 int getMaxResult()
          Get max results.
 java.lang.String getName()
          Get the worklist name.
 java.lang.String getPidString()
          Get the worklist persistent id (pid string)
 int getSelectionFilterOnNotify()
          Get selection filter on notify.
 int getSelectionFilterOnSuspend()
          Get selection filter on suspend.
 int getSelectionOrder()
          Get selection order.
 java.lang.String[] getWorkNodeNames()
          Get the worknode names
 void setACLName(java.lang.String aclName)
          Set acl name.
 void setConnection(CMBConnection connection)
          Set the reference of connection bean.
 void setDescription(java.lang.String description)
          Set the description.
 void setMaxResult(int maxResult)
          Set maxResult.
 void setName(java.lang.String name)
          Set the worklist name.
 void setPidString(java.lang.String pidString)
          Set the worklist pid.
 void setSelectionFilterOnNotify(int selectionFilterOnNotify)
          Set selection filter on notify.
 void setSelectionFilterOnSuspend(int selectionFilterOnSuspend)
          Set selection filter on suspend.
 void setSelectionOrder(int selectionOrder)
          Set selection order.
 void setWorkNodeNames(java.lang.String[] workNodeNames)
          Set the worknode names.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBWorkListICM

public CMBWorkListICM()
constructor
Method Detail

getSelectionOrder

public int getSelectionOrder()
Get selection order. The selection order may be one of the following:
Returns:
work list selection order. The default selection order is CMBWorkFlowConstants.CMB_ICM_DR_SELECTION_ORDER_PRIORITY.

setSelectionOrder

public void setSelectionOrder(int selectionOrder)
Set selection order. The selection order may be one of the following: The default selection order is CMBWorkFlowConstants.CMB_ICM_DR_SELECTION_ORDER_PRIORITY.
Parameters:
selectionOrder - work list selection order

getSelectionFilterOnNotify

public int getSelectionFilterOnNotify()
Get selection filter on notify. The selection filter on notify can be one of the following:
Returns:
work list selection filteron notify

setSelectionFilterOnNotify

public void setSelectionFilterOnNotify(int selectionFilterOnNotify)
Set selection filter on notify. The selection filter on notify can be one of the following:
Parameters:
selectionFilterOnNotify - work list selection filter on notify

getSelectionFilterOnSuspend

public int getSelectionFilterOnSuspend()
Get selection filter on suspend. The selection filter on suspend can be one of the following:
Returns:
work list selection filter on suspend

setSelectionFilterOnSuspend

public void setSelectionFilterOnSuspend(int selectionFilterOnSuspend)
Set selection filter on suspend. The selection filter on suspend can be one of the following:
Parameters:
selectionFilterOnSuspend - work list selection filter on suspend

getMaxResult

public int getMaxResult()
Get max results. The int for max results can be one of the following:
Returns:
work list max results

setMaxResult

public void setMaxResult(int maxResult)
Set maxResult. The int for max results can be one of the following:
Parameters:
maxResult - work list max results

getPidString

public java.lang.String getPidString()
Get the worklist persistent id (pid string)
Returns:
the pid string.

setPidString

public void setPidString(java.lang.String pidString)
Set the worklist pid.
Parameters:
pid - the worklist pid

setWorkNodeNames

public void setWorkNodeNames(java.lang.String[] workNodeNames)
Set the worknode names.
Parameters:
workNodeNames - the worknode names.

getWorkNodeNames

public java.lang.String[] getWorkNodeNames()
Get the worknode names
Returns:
the work node names.

getACLName

public java.lang.String getACLName()
Get acl name.
Returns:
the acl name.

setACLName

public void setACLName(java.lang.String aclName)
Set acl name.
Parameters:
aclName - the acl name

getName

public java.lang.String getName()
Get the worklist name.
Returns:
the worklist name.

setName

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

getDescription

public java.lang.String getDescription()
Get the description.
Returns:
description. Null is returned if description is not set.

setDescription

public void setDescription(java.lang.String description)
Set the description.
Parameters:
description - the description

setConnection

public void setConnection(CMBConnection connection)
Set the reference of connection bean.
Parameters:
connection - 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.