Index

DKWorkFlowServiceFed

Purpose:

DKWorkFlowServiceFed is the class to represent the implementation of workflow service for EIP that provides a set of methods for the document-based workflow. Hierarchy: dkService DKWorkFlowServiceFed

Class summary:

class DKWorkFlowServiceFed : public dkService
{
   public:
     DKWorkFlowServiceFed();
     DKWorkFlowServiceFed(const char * configuration);
     virtual ~DKWorkFlowServiceFed();
     
     virtual dkDatastore* getDatastore();
     virtual void setDatastore(dkDatastore* ds);
 
     virtual dkCollection* listWorkFlows();
     virtual dkCollection* listWorkFlows(const char* filter, 
                                         const char* sort_criteria,
                                         int threshold);
     virtual dkCollection* listWorkItems(const char* filter, 
                                         const char* sort_criteria,
                                         int threshold);
     virtual dkCollection* listWorkLists();
     virtual dkCollection* listWorkFlowTemplates();   
    
     virtual DKBoolean isWorkFlow(const char * name);
     virtual DKBoolean isWorkFlowTemplate(const char * name);
     virtual DKBoolean isWorkList(const char * name);
};

Members:

Constructors and destructor
The first constructor constructs a new DKWorkFlowServiceFed object. The second constructor also constructs a new DKWorkFlowServiceFed object with an optional configuration reserved for future use. The destructor deletes the DKWorkFlowServiceFed object.
DKWorkFlowServiceFed();
     DKWorkFlowServiceFed(const char * configuration);
     ~DKWorkFlowServiceFed();
  

Member functions

getDatastore
Gets the reference to the associated datastore object.
dkDatastore* getDatastore();  

setDatastore
Sets the reference to the associated datastore object.
void setDatastore(dkDatastore* ds);        
 

listWorkFlows
Returns a collection of DKWorkFlowFed objects in the system. Each DKWorkFlowFed object represents a workflow in EIP. The first form will return all the workflows. The second form only returns the workflows based on the filter, sort criteria, and threshold (DK_FED_FMC_MAX_RESULTS for max results).
dkCollection* listWorkFlows();   
     dkCollection* listWorkFlows(const char* filter, const char* sort_criteria, int threshold);

listWorkItems
Returns a collection of DKWorkItemFed objects in the system based on the given filter, sort criteria and threshold (DK_FED_FMC_MAX_RESULTS for max results). Each DKWorkItemFed object represents a work item in the system.
dkCollection* listWorkItems(const char* filter, const char* sort_criteria, int threshold);
            

listWorkLists
Returns a collection of DKWorkListFed objects in the system.
dkCollection* listWorkLists();

listWorkFlowTemplates
Returns a collection of DKWorkFlowTemplateFed objects in the system.
 dkCollection* listWorkFlowTemplates();   
  

isWorkFlow
Checks if the specified name is a workflow.
DKBoolean isWorkFlow(const char * name);

isWorkFlowTemplate
Checks if the specified name is a workflow template.
DKBoolean isWorkFlowTemplate(const char * name);

isWorkList
Checks if the specified name is a worklist.
DKBoolean isWorkList(const char * name);     

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