Index

DKWorkBasketDL

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:

Constructors and destructor
The first constructor contains two parameters; this parameter retrieves an existing workbasket in the memory. The second constructor contains one parameter; this parameter creates a new workbasket in the memory.
     DKWorkBasketDL(DKWorkFlowServiceDL * ws,
                    const char * itemIDWB);
     DKWorkBasketDL(DKWorkFlowServiceDL * ws);
     ~DKWorkBasketDL();
 

Member functions

addItem
Adds a document or folder item to an existing workbasket. An item can only reside in one workbasket at a time.

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:

  • DK_DL_WIP_DEFAULT_PRIORITY

    Uses the default priority of the index class for that item.

  • A priority value between 0 and 31 999

    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);
 

removeItem
Removes a document or folder item from a workbasket. The itemID parameter specifies the item ID of the document or folder.
        void removeItem(const char * itemID);
 

getNextHighPriorityItem
Returns the highest priority item in the workbasket. This function will only return the item if it is not suspended or checked out by another user. If the workbasket is empty, this function will return an empty string.
     dkString getNextHighPriorityItem();
 

listItemIDs
Based on the status of the work being processed, this function returns a collection of DKString objects that represent the item IDs of the documents or folders in the workflow. The valid wip_status values are:
  • DK_DL_ITEMS_NOT_IN_WORKFLOW

    returns items that are not in a workflow.

  • DK_DL_CURRENT_WORKFLOW_ITEMS

    returns items that are in a workflow.

  • DK_DL_COMPLETED_WORKFLOW_ITEMS

    returns completed items in a workflow.

  • DK_DL_CANCELLED_WORKFLOW_ITEMS

    returns items that were removed from a workflow.

  • DK_DL_WIP_ALL

    returns items without regard to their workflow status.

     dkCollection * listItemIDs(long wip_status);
 

listWorkManagementInfos
Returns a collection of DKWorkManagementInfoDL objects representing the documents or folders in the workflow. The valid values are:
  • DK_DL_ITEMS_NOT_IN_WORKFLOW

    returns items that are not in a workflow.

  • DK_DL_CURRENT_WORKFLOW_ITEMS

    returns items that are in a workflow.

  • DK_DL_COMPLETED_WORKFLOW_ITEMS

    returns completed items in a workflow.

  • DK_DL_CANCELLED_WORKFLOW_ITEMS

    returns items that were removed from a workflow.

  • DK_DL_WIP_ALL

    returns items without regard to their workflow status.

For detailed information about the DKWorkManagementInfoDL class, please refer to DKWorkManagementInfoDL.

     dkCollection * listWorkManagementInfos(long wip_status);
 

listItemIDsWF
Based on the specified workflow, this function returns a collection of DKString objects that represent the item IDs of the documents or folders in the workbasket.
     dkCollection * listItemIDsWF (const char * itemIDWF);
 

listWorkManagementInfosWF
Based on the specified workflow, this function returns a collection of DKWorkManagementInfoDL objects that represent the documents or folders in the workbasket. For detailed information about the DKWorkManagementInfoDL class, please refer to DKWorkManagementInfoDL.
     dkCollection * listWorkManagementInfosWF(const char * itemIDWF);
 

getID
Returns the item ID of the workbasket.
     dkString getID();
 

getName
Returns the name of the workflow.
     dkString getName();
 

getAccessList
Returns the name of the access list for the workflow.
     dkString getAccessList();
 

getLoadLimit
Returns the load limit of the workbasket. The value DK_DL_WB_NO_LOAD_LIMIT means that the workbasket can contain an unlimited number of items.
        long getLoadLimit();
 

getRemoveAfterIndex
Returns a flag that indicates whether the system will remove the item from the workbasket after the item is indexed. The valid values are:
TRUE -- after the item is indexed, it will be removed from the workbasket.
FALSE -- after the item is indexed, it will remain in the workbasket.

     dkBoolean getRemoveAfterIndex();
 

getSystemControl
Returns a flag that indicates whether the system controls the item priority within the workbasket. The valid values are:

TRUE
The workbasket is a system-assigned workbasket. The system will provide the highest priority item in the workbasket when an item is requested

FALSE
The workbasket is not a system-assigned workbasket. You can choose any item in the workbasket.

     dkBoolean getSystemControl();
 

getUserFunction
Returns the name of the user exit function to call when the workbasket's overload trigger exceeds the load limit. The function name is provided for your applications to use.
     dkString getUserFunction();

getUserDll
Returns the name of a DLL that contains the user exit function. The DLL name is provided for your applications to use.
     dkString getUserDll();
 

getPrivilegeString
Returns the privilege string of the user with respect to the workbasket.
     dkString getPrivilegeString();
 

getAssociatedWorkFlowIDs
Returns the item IDs of the workflows that are associated with this workbasket.
     dkCollection * getAssociatedWorkFlowIDs();
 

setID
Sets the item ID of the workbasket.
        void setID(const char * itemIDWB);
 

setName
Sets the name of the workbasket.
        void setName(const char * workbasket_name);
 

setAccessList
Sets the name of the access list of the workbasket.
        void setAccessList(const char * access_list);
 

setLoadLimit
Sets the load limit of the workbasket. The value DK_DL_WB_NO_LOAD_LIMIT means that the workbasket can contain an unlimited number of items.
        void setLoadLimit(long load_limit);
 

setRemoveAfterIndex
Sets a flag that indicates whether the system will remove the item from the workbasket after the item is indexed. The valid values are:

TRUE
After the item is indexed, it will be removed from the workbasket.

FALSE
After the item is indexed, it will remain in the workbasket.

        void setRemoveAfterIndex(DKBoolean remove_after_index);
 

setSystemControl
Sets a flag that indicates whether the system controls the item priority within the workbasket. The valid values are:

TRUE
The workbasket is a system-assigned workbasket. The system will provide the highest priority item in the workbasket when an item is requested.

FALSE
The workbasket is not a system-assigned workbasket. You can choose any item in the workbasket.

        void setSystemControl(DKBoolean system_control);
 

setUserFunction
Sets the name of the user exit function to call when the workbasket's overload trigger exceeds the load limit. The function name is provided for your applications to use.
        void setUserFunction(const char * user_function);

setUserDll
Sets the name of a DLL that contains the user exit function. The DLL name is provided for your applications to use.
        void setUserDll(const char * user_dll);
 

add
Adds the workflow into the system. The item ID of the workflow must be empty.
        void add();
 

update
Updates the workflow in the system. The retrieve() function must be called in conjunction with this function.
        void update();
 

del
Deletes the workflow from the system. The retrieve() function must be called in conjunction with this function.
        void del();
 

retrieve
Retrieves the workflow from the system and places it in the system memory cache. The item ID of the workflow must be valid before you can use this function.
        void retrieve();
 

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