Index

DXWorkBasketDL

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

itemID
the item ID of a document or folder

initial_priority
the priority to assign to the item moving into a workbasket. The valid values are:

DX_DL_WIP_DEFAULT_PRIORITY
use the default priority of the index class for the item

A priority value between 0 and 31 999
the numerical value that equates to the priority. Larger numbers equal higher priority

overload
a flag indicating the action to take if adding the item would overload the workbasket. When this flag is set to TRUE, the item will be added even if the workflow will be overloaded as a result of the addition. If the flag is set to FALSE, the item will not be added if the addition would overload the workflow

removeItem
removeItem(LPCTSTR itemID)  

Removes a document or folder item from a workbasket. The itemID parameter specifies the item ID of the document or folder.

getNextHighPriorityItem
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.

listItemIDs
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:

DX_DL_ITEMS_NOT_IN_WORKFLOW
returns items that are not in a workflow

DX_DL_CURRENT_WORKFLOW_ITEMS
returns items that are in a workflow

DX_DL_COMPLETED_WORKFLOW_ITEMS
returns completed items in a workflow; the history has been archived

DX_DL_CANCELLED_WORKFLOW_ITEMS
returns items that were removed from a workflow

DX_DL_FINISHED_WORKFLOW_ITEMS
returns completed items in a workflow; the history has been archived

DX_DL_WIP_ALL
returns items without regard to their WIP_STATUS

The returned LPDISPATCH pointer contains a DXSequentialCollectionDL object.

listWorkManagementInfos
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:

DX_DL_ITEMS_NOT_IN_WORKFLOW
returns items that are not in a workflow

DX_DL_CURRENT_WORKFLOW_ITEMS
returns items that are in a workflow

DX_DL_COMPLETED_WORKFLOW_ITEMS
returns completed items in a workflow; the history has been archived

DX_DL_CANCELLED_WORKFLOW_ITEMS
returns items that were removed from a workflow

DX_DL_FINISHED_WORKFLOW_ITEMS
returns completed items in a workflow; the history has been archived

DX_DL_WIP_ALL
returns items without regard to their WIP_STATUS

For detailed information about the DXWorkManagementInfoDL class, please refer to ***.

listItemIDsWF
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.

listWorkManagementInfosWF
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 ***.

getID
BSTR getID()  

Returns the item ID of the workflow.

getName
BSTR getName()

Returns the name of the workflow.

getAccessList
        String getAccessList();
 

Returns the name of the access list for the workflow.

getLoadLimit
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.

getRemoveAfterIndex
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:

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

getSystemControl
BOOL 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

getUserFunction
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.

getUserDll
BSTR getUserDll()

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

getPrivilegeString
BSTR getPrivilegeString()

Returns the privilege string of the user with respect to the workbasket.

getAssociatedWorkFlowIDs
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
setID(LPCTSTR itemIDWB)  

Sets the item ID of the workflow.

setName
setName(LPCTSTR workbasket_name)

Sets the name of the workbasket.

setAccessList
setAccessList(LPCTSTR access_list)

Sets the name of the access list of the workbasket.

setLoadLimit
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
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:

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

setSystemControl
setSystemControl(BOOL system_control)

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

setUserFunction
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
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
add();

Adds the workflow into the system. The item ID of the workflow must be empty.

update
update();
 

Updates the workflow in the system. The retrieve() method must be called in conjunction with this method.

del
del();
 

Deletes the workflow from the system. The retrieve() method must be called in conjunction with this method.

retrieve
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.