Index

DXWorkFlowDL

Purpose:

This class provides a set of functions for the WorkFlow feature in Content Manager datastore. This class allows the creation, revision, and deletion of a DXWorkFlowDL object.

Methods:

init
init(LPDISPATCH ws)

You must call this method after the creation of a DXWorkFlowServiceDL object in order to associate that object with a DXDatastoreDL object.

listItemIDs
LPDISPATCH listItemIDs()

Returns a collection of String objects that represent the item IDs of the documents or folders in the workflow.

listWorkManagementInfos
LPDISPATCH listWorkManagementInfos()

Returns a collection of DXWorkManagementInfoDL objects representing the documents or folders in the workflow. For detailed information about the DXWorkManagementInfoDL class, please refer to ***.

listWorkBasketIDs
LPDISPATCH listWorkBasketIDs()    

Returns a collection of String objects; these objects contain the item IDs of the workbaskets in the workflow.

listWorkBaskets
LPDISPATCH listWorkBaskets() 

Returns a collection of DXWorkBasketDL objects that represent the workbaskets in the workflow.

getID
BSTR getID()

Returns the item ID of the workflow.

getName
BSTR getName()

Returns the name of the workflow.

getAccessList
BSTR getAccessList()

Returns the name of the access list for the workflow.

getHistoryDisposition
long getHistoryDisposition()

Returns the disposition of the history log. The valid values are:

DX_DL_WF_SAVE_HISTORY
the log will save the entries

DX_DL_WF_DISCARD_HISTORY
the log will discard the entries up to the last workflow separator

getItemCount
long getItemCount()

Returns the number of items in the workflow.

getWorkBasketCount
long getWorkBasketCount()

Returns the number of workbaskets in the workflow.

getWorkBasketSequence
LPDISPATCH getWorkBasketSequence()

Returns the ordered collection of DXWorkBasketSequenceDL objects containing the item ID of workbaskets in the workflow. The returned LPDISPATCH pointer contains a DXWorkBasketSequenceDL object.

getPrivilegeString
BSTR getPrivilegeString()

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

setID
setID(LPCTSTR itemIDWF)

Sets the item ID of the workflow.

setName
 setName(LPCTSTR workflow_name)

Sets the name of the workflow.

setAccessList
setAccessList(LPCTSTR access_list)

Sets the name of the access list of the workflow.

setHistoryDisposition
setHistoryDisposition(long history_disposition)

Sets the disposition of the history log. The valid values are:

DX_DL_WF_SAVE_HISTORY
the log will save the entries

DX_DL_WF_DISCARD_HISTORY
the log will discard the entries up to the last workflow separator

setWorkBasketSequence
setWorkBasketSequence(LPDISPATCH workbasket_sequence)

Sets the sequence of workbaskets in a workflow. The parameter workbasket_sequence is an ordered collection of DXWorkBasketSequenceDL objects containing the item ID of the workbasket.

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.