Index

DKWorkListICM

Purpose:

This class contains the information about a WorkList in Document Routing.

Class summary:

{
 
         public:
            
            DKWorkListICM();
            virtual ~DKWorkListICM();
            
            DKString getPidString();
            DKString getName();
            DKString getDescription();
            DKString getACLName();
            DKString* getWorkNodeNames(long& arraySize);                        
            int getSelectionOrder();                                            
            int getSelectionFilterOnSuspend();                                  
            int getSelectionFilterOnNotify();                                   
            int getSelectionFilterOnOwner();                                    
            DKString getSelectionFilterOwnerName();
            int getMaxResult();                                                 
            
            void setPidString(const char* worklist_pid);
            void setName(const char* worklist_name);
            void setDescription(const char* description);
            void setACLName(const char* acl_name);
            void setWorkNodeNames(DKString* worknode_list, long arraySize);     
            void setSelectionOrder(int selection_order);                        
            void setSelectionFilterOnSuspend(int selection_filter);             
            void setSelectionFilterOnNotify(int selection_filter);              
            void setSelectionFilterOnOwner(int selection_filter);               
            void setSelectionFilterOwnerName(const char* owner);                
            void setMaxResult(int result_number);                               
       }

Members:

Constructors and destructor
Constructs a new DKWorkListICM object. The destructor deletes the DKWorkListICM object.
DKWorkListICM();
virtual ~DKWorkListICM();

Member functions

getACLName
Returns the Name of the ACL.
DKString getACLName()

getDescription
Returns the description of the Work list.
DKString getDescription()

getMaxResult
Returns the Max Results that is set (0 = all, 1 = system assigned, > 1 for a limit)
 int  getMaxResult();

getName
Returns the Name of the WorkList.
 DKString getName();

getPidString
Returns the Pid String.
DKString getPidString();

getSelectionFilterOnNotify
Returns the Filter on Notify Value.
 int getSelectionFilterOnNotify()

getSelectionFilterOnOwner
Returns the value for the Filter on Owner setting.
int  getSelectionFilterOnOwner()

getSelectionFilterOnSuspend
Returns the value of the Filter on Suspend setting.
int  getSelectionFilterOnSuspend()

getSelectionFilterOwnerName
Returns the Filter Owner Name.
DKString getSelectionFilterOwnerName();

getSelectionOrder
Returns the Selection Order.

getWorkNodeNames
Returns an array of WorkNode Names.
DKString* getWorkNodeNames(long& arraySize)

setACLName
Sets the name of the ACL.
void setACLName(const char* acl_name);

setDescription
Sets the description for the WorkList.
void setDescription(const char* description);

setMaxResult
Sets the Maximum Returned results ( 0 = all, 1 = system assigned, > 1 for a limit)
void setMaxResult(int result_number);

setName
Sets the Name of the WorkList.
void setName(const char* worklist_name);

setPidString
Sets the PID. This Method should not be used and does nothing.
void setPidString(const char* worklist_pid);

setSelectionFilterOnNotify
Sets the selection filter on notify for this WorkList
  • DK_ICM_DR_SELECTION_FILTER_NO : 0
  • DK_ICM_DR_SELECTION_FILTER_YES : 1
  • DK_ICM_DR_SELECTION_FILTER_EITHER : 2

void setSelectionFilterOnNotify(int        selection_filter);

setSelectionFilterOnOwner
Sets the selection filter on owner for this WorkList.
  • DK_ICM_DR_SELECTION_FILTER_NO : 0
  • DK_ICM_DR_SELECTION_FILTER_YES :1

void setSelectionFilterOnOwner(int selection_filter);

setSelectionFilterOwnerName
Sets the Filter on Owner Name.
void setSelectionFilterOwnerName(const char* owner)

setSelectionOrder
Gets the selection order of this WorkList by priority : 0 by date : 1
void setSelectionOrder(int selection_order)

setWorkNodeNames
Sets the WorkNode Names.
void setWorkNodeNames(DKString* worknode_list, long arraySize);

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