Index

DKWorkListFed

Purpose:

DKWorkListFed is an object oriented representation of a worklist in the system. A worklist is defined in the system, and it is a collection of workitems. Hierarchy: DKWorkListFed

Class summary:

class DKWorkListFed 
{
   public:  
     DKWorkListFed(DKWorkFlowServiceFed* wfs,
                        const char * name);
     DKWorkListFed(DKWorkFlowServiceFed* wfs);
     virtual ~DKWorkListFed();
 
     virtual DKString getName();
     virtual DKString getDescription();
     
     virtual DKString getOwner();
     virtual long getThreshold();
     virtual DKString getFilter();  
     virtual DKString getSortCriteria();
     virtual DKString getACLName();
 
     virtual void setName(const char * name);
     virtual void setDescription(const char * description);
    
     virtual void setOwner(const char * owner_name);
     virtual void setThreshold(long threshold);
     virtual void setFilter(const char * filter);
     virtual void setSortCriteria(const char * sort_criteria);
     virtual void setACLName(const char * acl_name);
 
     virtual dkCollection* listWorkItems();
     virtual dkCollection* listWorkItemsByTemplate(const char * template_name);
     virtual dkCollection* listWorkItemsByNode(const char * node_name);
     virtual dkCollection* listWorkItemsByTemplateAndNode(const char * template_name, 
                                                          const char * node_name);
 
     virtual dkCollection* listProcessNotifications();
     virtual dkCollection* listActivityNotifications();
 
     virtual void add();
     virtual void update();
     virtual void del();
     virtual void retrieve();
};

Members:

Constructors and destructor
The first constructor constructs a DKWorkListFed object with the specified workflow service. The second constructor constructs a DKWorkListFed object with the specified workflow service and a worklist name. The destructor deletes the DKWorkListFed object.
DKWorkListFed(DKWorkFlowServiceFed* wfs, const char * name);
     DKWorkListFed(DKWorkFlowServiceFed* wfs);
     ~DKWorkListFed();  

Member functions

getName
Returns the name the worklist.
 DKString getName();  

setName
Sets the name of the worklist.
void setName(const char * name);        
 

getDescription
Returns the description of the worklist.
DKString getDescription();          

setDescription
Sets the description of the worklist.
void setDescription(const char * description);

getOwner
Gets the owner of the worklist.
DKString getOwner();           

getThreshold
Gets the threshold of the worklist.
long getThreshold();          

getFilter
Gets the filter of the worklist.
DKString getFilter();  

getSortCriteria
Gets the sort criteria of the worklist.
DKString getSortCriteria();           

getACLName
Gets the ACL name of the worklist.
DKString getACLName();           

setOwner
Sets the owner of the worklist.
void setOwner(const char * owner_name);
           

setThreshold
Sets the threshold of the worklist. Use DK_FED_FMC_MAX_RESULTS to return all of the results.
void setThreshold(long threshold);           

setFilter
Sets the filter name of the worklist.
void setFilter(const char * filter);

setSortCriteria
Sets the sort criteria of the worklist.
void setSortCriteria(const char * sort_criteria);           

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

listWorkItems
Returns a collection of workitems.
dkCollection* listWorkItems();           

listWorkItemsByTemplate
Returns a collection of workitems by the specified workflow template name.
dkCollection* listWorkItemsByTemplate(const char * template_name);
  

listWorkItemsByNode
Returns a collection of workitems by the specified node name.
dkCollection* listWorkItemsByNode(const char * node_name);           

listProcessNotifications
Returns a collection of process notifications represented as DKWorkFlowNotificationFed objects.
dkCollection* listProcessNotifications();

listActivityNotifications
Returns a collection of activity notifications represented as DKWorkFlowNotificationFed objects.
dkCollection* listActivityNotifications();

add
Adds a new worklist.
void add(const char *  workflow_template); 
 

update
Updates the worklist.
 void update();           

del
Deletes the worklist.
void del();             

retrieve
Retrieves and refreshes the information of the worklist.
void retrieve();              

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