Purpose:
This class provides a set of functions for the WorkBasket feature in the Content Manager datastore. This class allows the creation, revision, and deletion of a DXWorkBasketDL object.
Methods:
init(LPDISPATCH ws)
You must call this method following the creation of a DXWorkBasketDL object to associate to a DXWorkFlowServiceDL object. The input parameter LPDISPATCH pointer contains a DXWorkFlowServiceDL object.
addItem(LPCTSTR itemID, long initial_priority, BOOL overload)
Adds a document or folder item to an existing workbasket. An item can reside in one workbasket at a given time.
Parameters
removeItem(LPCTSTR itemID)
Removes a document or folder item from a workbasket. The itemID parameter specifies the item ID of the document or folder.
BSTR getNextHighPriorityItem()
Returns the highest priority item in the workbasket if the item is not suspended or checked out to another user. If the workbasket is empty, an empty string will be returned.
LPDISPATCH listItemIDs(long wip_status)
Returns a collection of String objects representing the item IDs of either documents or folders in the workbasket based on the specified work-in-process status (long). The work-in-process status can be one of the following:
The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object.
LPDISPATCH listWorkManagementInfos(long wip_status)
Returns a collection of DXWorkManagementInfoDL objects representing either documents or folders in the workbasket based on the specified work-in-process status (long). The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object. long can be one of the following:
For detailed information about the DXWorkManagementInfoDL class, please refer to ***.
LPDISPATCH listItemIDsWF(LPCTSTR itemIDWF)
Returns a collection of String objects; these objects represent the item IDs of the documents or folders in the workbasket of the specified workflow. The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object.
LPDISPATCH listWorkManagementInfosWF(LPCTSTR itemIDWF)
Returns a collection of DXWorkManagementInfoDL objects representing either documents or folders in the workbasket with respect to the specified workflow. The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object.
For detailed information about the DXWorkManagementInfoDL class, please refer to ***.
BSTR getID()
BSTR getName()
String getAccessList();
BSTR getAccessList()
Returns the load limit of the workbasket. The value DX_DL_WB_NO_LOAD_LIMIT means that the workbasket can contains an unlimited number of items.
BOOL 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:
BOOL getSystemControl()
Returns a flag that indicates whether the system controls the item priority within the workbasket. The valid values are:
BSTR 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.
BSTR getUserDll()
Returns the name of a DLL that contains the user exit function. The DLL name is provided for your applications to use.
BSTR getPrivilegeString()
Returns the privilege string of the user with respect to the workbasket.
LPDISPATCH getAssociatedWorkFlowIDs()
Returns a collection of string objects containing the item IDs of the workflows that are associated with this workbasket. The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object.
setID(LPCTSTR itemIDWB)
setName(LPCTSTR workbasket_name)
setAccessList(LPCTSTR access_list)
setLoadLimit(long load_limit)
Sets the load limit of the workbasket. The value DX_DL_WB_NO_LOAD_LIMIT means that the workbasket can contains an unlimited number of items.
setRemoveAfterIndex(BOOL remove_after_index)
Sets a flag that indicates whether the system will remove the item from the workbasket after the item is indexed. The valid values are:
setSystemControl(BOOL system_control)
Sets a flag that indicates whether the system controls the item priority within the workbasket. The valid values are:
setUserFunction(LPCTSTR user_function)
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.
setUserDll(LPCTSTR user_dll)
Sets the name of a DLL that contains the user exit function. The DLL name is provided for your applications to use.
add();
Adds the workflow into the system. The item ID of the workflow must be empty.
update();
Updates the workflow in the system. The retrieve() method must be called in conjunction with this method.
del();
Deletes the workflow from the system. The retrieve() method must be called in conjunction with this method.
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 method.
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.