Purpose:
The DKWorkBasketDL class is an object-oriented representation of a workbasket item in Content Manager.
Class summary:
class DKWorkBasketDL { public: DKWorkBasketDL(DKWorkFlowServiceDL * ws, const char * itemIDWB); DKWorkBasketDL(DKWorkFlowServiceDL * ws); ~DKWorkBasketDL(); void addItem(const char * itemID, long initial_priority, dkBoolean overload); void removeItem(const char * itemID); dkString getNextHighPriorityItem(); dkCollection * listItemIDs(long wip_status); dkCollection * listWorkManagementInfos(long wip_status); dkCollection * listItemIDsWF(const char * itemIDWF); dkCollection * listWorkManagementInfosWF(const char * itemIDWF); dkString getID(); dkString getName(); dkString getAccessList(); long getLoadLimit(); dkBoolean getRemoveAfterIndex(); dkBoolean getSystemControl(); dkString getUserFunction(); dkString getUserDLL(); dkString getPrivilegeString(); dkCollection * getAssociatedWorkFlowIDs(); void setID(const char * itemIDWB); void setName(const char * workbasket_name); void setAccessList(const char * access_list); void setLoadLimit(long load_limit); void setRemoveAfterIndex(DKBoolean remove_after_index); void setSystemControl(DKBoolean system_control); void setUserFunction(const char * user_function); void setUserDLL(const char * user_dll); void add(); void update(); void del(); void retrieve(); };
Members:
DKWorkBasketDL(DKWorkFlowServiceDL * ws, const char * itemIDWB); DKWorkBasketDL(DKWorkFlowServiceDL * ws); ~DKWorkBasketDL();
The itemID parameter specifies the item ID of a document or folder. The initial_priority parameter assigns the initial priority of the item that you want to place in a workbasket. The valid values are:
Uses the default priority of the index class for that item.
The numerical value that equates to the priority. Larger numbers equal higher priority.
The overload parameter indicates the action to take if adding the item would overload the workbasket. When this parameter is set to TRUE, the item will be added even if the workflow will be overloaded as a result of the addition. If the parameter is set to FALSE, the item will not be added if the addition would overload the workflow.
void addItem(const char * itemID, long initial_priority, dkBoolean overload);
void removeItem(const char * itemID);
dkString getNextHighPriorityItem();
returns items that are not in a workflow.
returns items that are in a workflow.
returns completed items in a workflow.
returns items that were removed from a workflow.
returns items without regard to their workflow status.
dkCollection * listItemIDs(long wip_status);
returns items that are not in a workflow.
returns items that are in a workflow.
returns completed items in a workflow.
returns items that were removed from a workflow.
returns items without regard to their workflow status.
For detailed information about the DKWorkManagementInfoDL class, please refer to DKWorkManagementInfoDL.
dkCollection * listWorkManagementInfos(long wip_status);
dkCollection * listItemIDsWF (const char * itemIDWF);
dkCollection * listWorkManagementInfosWF(const char * itemIDWF);
dkString getID();
dkString getName();
dkString getAccessList();
long getLoadLimit();
dkBoolean getRemoveAfterIndex();
dkBoolean getSystemControl();
dkString getUserFunction();
dkString getUserDll();
dkString getPrivilegeString();
dkCollection * getAssociatedWorkFlowIDs();
void setID(const char * itemIDWB);
void setName(const char * workbasket_name);
void setAccessList(const char * access_list);
void setLoadLimit(long load_limit);
void setRemoveAfterIndex(DKBoolean remove_after_index);
void setSystemControl(DKBoolean system_control);
void setUserFunction(const char * user_function);
void setUserDll(const char * user_dll);
void add();
void update();
void del();
void retrieve();
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.