Index

DKWorkPackageICM

Purpose:

This class represents a work package in Document Routing.

Class summary:

  class DKEXPORT DKWorkPackageICM
         {
 
         public:
            
            DKWorkPackageICM();
            virtual ~DKWorkPackageICM();
            
            DKString getPidString();
            int getInstance();
            DKString getItemPidString();
            int getPriority();
            DKString getProcessName();
            DKString getWorkNodeName();
            DKString getUserLastMoved();
            DKTimestamp getTimeLastMoved();
            int getSuspendState();
            int getNotifyState();
            DKTimestamp getNotifyTime();
            DKTimestamp getResumeTime();
            dkCollection* getResumeList();                       
            DKString getOwner();
            
            void setPidString(const char* workpackage_pid);
            void setInstance(int instance);
            void setItemPidString(const char* item_pid);
            void setPriority(int priority);
            void setProcessName(const char* process_name);
            void setWorkNodeName(const char* worknode_name);
            void setUserLastMoved(const char* user_last_moved);
            void setTimeLastMoved(DKTimestamp time_last_moved);
            void setSuspendState(int suspend_state);
            void setNotifyState(int notify_state);
            void setNotifyTime(DKTimestamp notify_time);
            void setResumeTime(DKTimestamp resume_time);
            void setResumeList(dkCollection* resume_list);  
            void setOwner(const char* owner);
          }

Members:

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

Member functions

getInstance
Returns an Instance of a the Work Pacakge.
getInstance();

getItemPidString
Returns the PidString for item associated with the Work Package
DKString getPidString();

getNotifyTime
Returns the Notification Time .
DKTimeStamp getNotifyTime();

getNotifyState
Returns the Notification State
DKString getNotify State();

getOwner
Returns the Work Package Owner.
DKString  getOwner();

getPidString
Returns the PidString.
DKString getPidString();

getPriority
Returns the Priority of the Work Package.
int getPriority();

getProcessName
Returns the name of the Process.
DKString  getProcessName();

getResumeList
Returns a collection of DKResumeListEntryICM objects. Each DKResumeListEntryICM object represents the items that are required to resume the process.
dkCollection* getResumeList();

getResumeTime
Return the time to resume the process.
DKTimeStamp  getResumeTime();

getSuspendedState
Returns the value indicating the Suspend State of this Work Package.
int getSuspendedState();

getTimeLastMoved
Returns the time the process last moved.
DKTimeStamp geTimeLastMoved();

getUserLastMoved
Returns the name of the User that last moved the Work Package.
DKString getUserLastMoved();

getWorkNodeName
Returns the WorkNode Name.
DKString  getWorkNodeName();

setInstance
Sets the Instance of this WorkPackage.
setInstance(int instance);

setItemPidString
Sets the Item Pid String of the WorkPackage.
setItemPidString(const char* item_pid);

setNotifyState
Set the Notify State of the WorkPackage.
setNotifyState(int notify_state);

setNotifyTime
Set the Notify Time of the Work Package.
setNotifyTime(DKTimestamp notify_time);

setOwner
Set the Owner of the Work Package.
 setOwner(const char *owner);

setPidString
sets the Pid of the Work Package.
setPidString(const char *workpackage_pid);

setPriority
Sets the Priority.
setPriority(int priority);

setProcessName
Sets the Process Name of the Work Package.
setProcessName(const char *process_name);

setResumeList
Sets the Resume List. The resume list contains a collection of DKResumeListEntryICM objects. Each DKResumeListEntryICM object represents the items that are required for a suspended process to Continue.
setResumeList(dkCollection *resume_list);

setResumeTime
Sets the Time to Resume.
setResumeTime(DKTimestamp resume_time);

setSuspendState
Sets the Suspend State.
 setSuspendState(int suspend_state);

setTimeLastMoved
Sets the Time the Work Package was last moved.
setTimeLastMoved(DKTimestamp time_last_moved);

setUserLastMoved
Sets the User that last moved the Work Package.
setUserLastMoved(const char *user_last_moved);

setWorkNodeName
Set the WorkNode Name.
setWorkNodeName(const char *worknode_name);

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