Purpose:
The DXWorkFlowServiceDL class defines the workflow service for the Content Manager datastore; this class provides the workflow processing mechanisms for Content Manager.
Methods:
init(LPDISPATCH ds)
You must call this method after the creation of a DXWorkFlowServiceDL object in order to associate that object with a DXDatastoreDL object. The input parameter LPDISPATCH pointer contains a DXDatastoreDL object.
BSTR workFlowServiceType()
BSTR workFlowServiceName()
BSTR userName()
BOOL isConnected()
Returns the status of the connection after attempting to connect to the Content Manager datastore that is providing workflow service.
startWorkFlowItem(LPCTSTR itemID, LPCTSTR itemIDWF, LPCTSTR itemIDWB, BOOL overload, long initial_priority)
Starts either a document or a folder in a workflow. This method assigns the item to the specified workbasket. After an item is placed in a workflow, a history log becomes associated with that item. This log tracks all activity for the item during the workflow.
Parameters
startWorkFlowItemInFirstWB(LPCTSTR itemID, LPCTSTR itemIDWF, BOOL overload, long initial_priority)
Starts either a document or a folder in a workflow. This method assigns the item to the first workbasket of the workflow. After an item is placed in a workflow, a history log becomes associated with that item. This log tracks all activity for the item during the workflow.
Parameters
changeWorkFlowItem(LPCTSTR itemID, LPCTSTR itemIDWF)
Changes the workflow of an item that is currently being processed. This method removes the item from its current workflow and places it into the specified workflow.
startWorkFlowItemInFirstWB(LPCTSTR itemID, LPCTSTR itemIDWF, BOOL overload, long initial_priority)
Starts either a document or a folder in a workflow. This method assigns the item to the first workbasket of the workflow. After an item is placed in a workflow, a history log becomes associated with that item. This log tracks all activity for the item during the workflow.
Parameters
removeWorkFlowItem(LPCTSTR itemID)
Removes the item from its workflow; however, the item stays in its workbasket.
completeWorkFlowItem(LPCTSTR itemID)
Removes the item from its workflow and sets the item's status to indicate workflow completion.
routeWipItem(LPCTSTR itemID, LPCTSTR itemIDWB, BOOL overload, long priority)
Moves the specified item from its current workbasket into the workbasket that you specify.
Parameters
BSTR getNextWorkBasketID(LPCTSTR itemID)
Returns the item ID of the next workbasket in the workflow of the specified item.
LPDISPATCH getNextWorkBasket(LPCTSTR itemID)
Returns the next workbasket in the workflow of the specified item.
long getWorkBasketItemPriority(LPCTSTR itemID)
setWorkBasketItemPriority(LPCTSTR itemID, long priority)
Changes the assigned priority of an item. You can assign any number between 0 and 31 999 as the priority value. Larger numbers equal higher priority.
LPDISPATCH listWorkFlowIDs()
Returns a collection of String objects containing the item ID of every workflow defined in the system.
DXSequentialCollection listWorkFlows();
Returns a collection of DXWorkFlowDL objects defined in the system.
LPDISPATCH listWorkFlows()
Returns a collection of String objects containing the item ID of every workbasket defined in the system.
LPDISPATCH listWorkBasketIDs()
Returns a collection of the DXWorkBasketDL objects that are defined in the system.
long itemIDType(LPCTSTR itemID)
Returns ITEM_TYPE indicating the type of an item ID. The following values are valid ITEM_TYPE types:
LPDISPATCH workManagementInfo(LPCTSTR itemID)
Returns a DXWorkManagementInfoDL object describing the work management information of the specified document or folder item. The structure of the DXWorkManagementInfoDL class is:
DXWorkManagementInfoDL { BSTR getItemID() long getSuspensionStatus() long getWorkFlowStatus() long getReleaseType() long getPriority() BSTR getWorkFlowID() BSTR getWorkBasketID() LPDISPATCH getWFEntry() LPDISPATCH getWBEntry() }
BSTR getItemID()
long getSuspensionStatus()
Returns SUSPENSION_STATUS indicating the current suspension status. The valid values are:
long getWorkFlowStatus()
Returns WIP_STATUS indicating the current workflow status. The valid values are:
long getReleaseType()
Returns RELEASE_TYPE indicating the type of criteria that must be met before an item can be released from suspension. The valid values are:
long getPriority()
Returns a long integer indicating the current priority of the item within the workbasket.
BSTR getWorkFlowID()
Returns a string containing the Workflow ID to which this item is assigned (if such an ID exists).
BSTR getWorkBasketID()
LPDISPATCH getWFEntry()
Returns a DXTimestamp containing the date and time when this item entered the listed workflow.
LPDISPATCH getWBEntry()
Returns a DXTimestamp containing the date and time with this item entered the listed workbasket.
The structure of the DXTimestamp is:
class DXTimestamp { BSTR asString(); long getYear(); long getMonth(); long getDay(); long getHours(); long getMinutes(); long getSeconds(); long getNanos(); };
BSTR asString();
long getYear();
long getMonth();
long getDay();
long getHours();
long getMinutes();
long getSeconds();
long getNanos();
Returns the nanoseconds of the timestamp.
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.