Index

DKDocRoutingServiceICM

Purpose:

This Class is the starting point for Document Routing Management. It provides a set of basic document routing functions.

Class summary:

class DKEXPORT DKDocRoutingServiceICM : public dkService
 {
public:
            DKDocRoutingServiceICM(DKDatastoreICM* pds);
            virtual ~DKDocRoutingServiceICM();   
            //  dkService overrides
            DKBoolean isConnected();
            DKHandle* connection();
            DKString startProcess(const char* process_name, const char* item_pid, int priority, const char* owner);  
            void terminateProcess(const char* workpackage_pid);
            DKString continueProcess(const char* workpackage_pid, const char* selection, const char* owner);         
            void suspendProcess(const char* workpackage_pid, int duration, dkCollection* resume_list);               
            void resumeProcess(const char* workpackage_pid);
            DKWorkPackageICM* getNextWorkPackage(const char* worklist_name, const char* owner);                                                          
            DKString getNextWorkPackagePidString(const char* worklist_name, const char* owner);                                                          
            DKBoolean checkOutItemInWorkPackage(const char* workpackage_pid);                                                                              
                                                                                                                                                                                                                                                  
            int getCount(const char* worklist_name, const char* owner);                                                                                                                
            DKString* listWorkPackagePidStrings(const char* worklist_name, const char* owner, long& arraySize);      
            DKDocRoutingServiceMgmtICM* getDocRoutingServiceMgmt();
            int getWorkPackagePriority(const char* workpackage_pid);
            void setWorkPackagePriority(const char* workpackage_pid, int priority);
            DKString getWorkPackageOwner(const char* workpackage_pid);
            void setWorkPackageOwner(const char* workpackage_pid, const char* owner);
            DKWorkPackageICM* retrieveWorkPackage(const char* workpackage_pid);
            DKString* listWorkPackagePidStringsWithItem(const char* item_pid, long& arraySize);
 }

Members:

Constructors and destructor
Constructs a new DKDocRoutingServiceICM object. Copy constructor to construct a DKDocRoutingServiceICM object. 
 
           DKDocRoutingServiceICM(DKDatastoreICM* pds);
virtual  ~DKDocRoutingServiceICM();

Member functions

checkOutItemInWorkPackage()
Check out the item associated with the work package, returns true if successful or false when failed.
checkOutItemInWorkPackage(const char* workpackage_pid)

connection()
Returns a connection to the Datastore.
DKHandle* connection();

continueProcess()
Allows a particular Workpackage to Continue.
DKString continueProcess(const char* workpackage_pid, const char* selection, const char* owner)

getCount
Returns the count of work packages for the specified worklist.
 int getCount(const char* worklist_name, const char* owner);

getDocRoutingServiceMgmt
Returns a pointer to DKDocRoutingServiceMgmtICM.
DKDocRoutingServiceMgmtICM* getDocRoutingServiceMgmt();

getNextWorkPackage
Returns the next WorkPackage in the specified worklist and checks out the item if it is not being checked out.
DKWorkPackageICM* getNextWorkPackage(const char* worklist_name, const char* owner);

getNextWorkPackagePidString
Returns the PID for the Next WorkPackage and checks out the item if it is not being checked out.
DKString getNextWorkPackagePidString(const char* worklist_name, const char* owner)

getWorkPackageOwner
Gets the WorkPackage Owner.
 DKString getWorkPackageOwner(const char* workpackage_pid);

getWorkPackagePriority
Gets the Work Package Priority.
int getWorkPackagePriority(const char* workpackage_pid);

isConnected
Returns the status of connecting to the service.
DKBoolean isConnected()

listWorkPackagePidStrings
Returns an array of all the Work Package PID strings in the specified worklist.
DKString* listWorkPackagePidStrings(const char* worklist_name, const char* owner, long& arraySize)

listWorkPackagePidStringsWithItem
Returns a collection of work package Pid strings with Items .
DKString* listWorkPackagePidStringsWithItem(const char* item_pid, long& arraySize)

resumeProcess
Resume Process for a Work Package.
void resumeProcess(const char* workpackage_pid)

retrieveWorkPackage
Retrieves a Work Package
DKWorkPackageICM* retrieveWorkPackage(const char* workpackage_pid)

retrieveWorkPackage
Sets the Work Package Owner
DKWorkPackageICM* retrieveWorkPackage(const char* workpackage_pid

setWorkPackagePriority
Sets the Work Package Priority
 void setWorkPackagePriority(const char* workpackage_pid, int priority)

startProcess
Starts a Document Routing process for a Work Package.
DKString startProcess(const char* process_name, const char* item_pid, int priority, const char* owner)

suspendProcess
Suspends a process with the specified Work Package.
void suspendProcess(const char* workpackage_pid, int duration, dkCollection* resume_list)

terminateProcess
Terminates a process with the specified Work Package.
void terminateProcess(const char* workpackage_pid)

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