Index

DKWorkNodeICM

Purpose:

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

Class summary:

 {
 
         public:
 
                 DKWorkNodeICM();
                 virtual ~DKWorkNodeICM();
 
            int getType();                                                                                               
                 DKString getPidString();
                 DKString getName();
                 DKString getDescription();
                 DKString getACLName();
                 int getTimeLimit();
                 int getOverloadLimit();
                 DKString getOverloadUserFunction();
                 DKString getOverloadUserDll();
                 DKString getEnterUserFunction();
                 DKString getEnterUserDll();
                 DKString getLeaveUserFunction();
                 DKString getLeaveUserDll();
                 dkCollection* getCollectionResumeList();                        
                 
                 void setType(int worknode_type);
                 void setPidString(const char* worknode_pid);
                 void setName(const char* worknode_name);
                 void setDescription(const char* description);
                 void setACLName(const char* acl_name);
                 void setTimeLimit(int time_limit);
                 void setOverloadLimit(int overload_limit);
                 void setOverloadUserFunction(const char* user_function);
                 void setOverloadUserDll(const char* user_dll);
                 void setEnterUserFunction(const char* user_function);
                 void setEnterUserDll(const char* user_dll);
                 void setLeaveUserFunction(const char* user_function);
                 void setLeaveUserDll(const char* user_dll);
                 void setCollectionResumeList(dkCollection* resume_list);        
 
       }

Members:

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

Member functions

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

getCollectionResumeList
Returns a resume list for the Collection Point. It contains a set of DKCollectionResumeListEntryICM objects.
dkCollection* getCollectionResumeList()

getDescription
Returns the Description of the WorkNode.
DKString  getDescription()

getEnterUserDll
Returns File Name of the DLL called upon entry into the WorkNode.
DKString getEnterUserDll();

getEnterUserFunction
Returns the Function name inside the DLL that is called upon entry into the WorkNode .
DKString getEnterUserFunction();

getLeaveUserDll
Returns the File Name of the a DLL called upon exit from the WorkNode.
DKString getLeaveUserDll();

getLeaveUserFunction
Returns the Function name indside the DLL that is called upon exit from the WorkNode .
DKString getleaveUserFunction();

getName
Returns the name of the WorkNode.
DKString getName();

getOverloadLimit
Returns the value of the Overload Limit.
int getOverloadLimit()

getOverloadUserDll
Returns the File Name of the Overload User DLL.
DKString getOverloadUserDll();

getOverloadUserFunction
Returns the Function Name Inside the the Overload User DLL.
DKString getOverloadUserFunction()

getPidString
Returns the Pid String Value for the WorkNode.
DKString getPidString();

getTimeLimit
Returns the Time Limit for the Work Node.
 int getTimeLimit()

getType
Returns the Type of the WorkNode. (Regular WorkBasket=0, Collection Point=1)
 int getType()

setACLName
Sets the ACL Name.
void setACLName(const char* acl_name)

setCollectionResumeList
Sets the resume list for the Collection Point. It contains a set of DKCollectionResumeListEntryICM objects.
void setCollectionResumeList(dkCollection* resume_list);

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

setEnterUserDll
Sets the File Name of the DLL called upon entry into the WorkNode?
 void setEnterUserDll(const char* user_dll);

setEnterUserFunction
Sets the Function called in the DLL upon the Entry of the WorkNode.

void setDescription(const char* description);

setLeaveUserDll
Sets the File Name of the DLL called upon exit from the WorkNode.
void setEnterUserDll(const char* user_dll);

setLeaveUserFunction
Sets the Function name inside the DLL that is called upon exit from the Work Node.
void setDescription(const char* description);

setName
Sets the Name of the WorkNode.
void setName(const char* worknode_name)

setOverloadLimit
Sets the OverLoad Limit.
void setOverloadLimit(int overload_limit);

setOverloadUserDll
Sets the File Name of the Overload DLL
void setOverloadUserDll(const char* user_dll)

setOverloadUserFunction
Sets the User DLL Function in the Overload DLL.
void setOverloadUserFunction(const char* user_function)

setPidString
Sets the PID String.
void setPidString(const char* worknode_pid)

setTimeLimit
Sets the Time Limit.
void setTimeLimit(int time_limit)

setType
Sets the Type (Regular WorkBasket=0, Collection Point=1)
void setType(int worknode_type)

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