Index

DKWorkFlowDL

Purpose:

The DKWorkFlowDL class is an object-oriented representation of a workflow item in Content Manager.

Class summary:

    class DKWorkFlowDL
    {
   public:
     DKWorkFlowDL(DKWorkFlowServiceDL * ws,
                  const char * itemIDWF);
     DKWorkFlowDL(DKWorkFlowServiceDL * ws);
     ~DKWorkFlowDL();
        
     dkCollection * listItemIDs();
     dkCollection * listWorkManagementInfos();
     dkCollection * listWorkBasketIDs();
     dkCollection * listWorkBaskets();
 
     dkString getID();
     dkString getName();
     dkString getAccessList();
     long getHistoryDisposition();
     long getItemCount();
     long getWorkBasketCount();
     dkCollection * getWorkBasketSequence();
     dkString getPrivilegeString();
 
     void setID(const char * itemIDWF);
     void setName(const char * workflow_name);
     void setAccessList(const char * access_list);
     void setHistoryDisposition(long history_disposition);
     void setWorkBasketSequence(dkCollection * workbasket_sequence);
 
     void add();
     void update();
     void del();
     void retrieve();
    };    

Members:

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

Member functions

listItemIDs
Returns a collection of DKString objects that represent the item IDs of the documents or folders in the workflow.
     dkCollection * listItemIDs();
 

listWorkManagementInfos
Returns a collection of DKWorkManagementInfoDL objects representing the documents or folders in the workflow. For detailed information about the DKWorkManagementInfoDL class, please refer to DKWorkManagementInfoDL.
     dkCollection * listWorkManagementInfos();
 

listWorkBasketIDs
Returns a collection of DKString objects; these objects contain the item IDs of the workbaskets in the workflow.
     dkCollection * listWorkBasketIDs();
 

listWorkBaskets
Returns a collection of DKWorkBasketDL objects that represent the workbaskets in the workflow.
     dkCollection * listWorkBaskets();
 

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

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

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

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

DK_DL_WF_SAVE_HISTORY
the log will save the entries.

DK_DL_WF_DISCARD_HISTORY
the log will discard the entires up to the last workflow separator.

        long getHistoryDisposition();
 

getItemCount
Returns the number of items in the workflow.
        long getItemCount();
 

getWorkBasketCount
Returns the number of workbaskets in the workflow.
        long getWorkBasketCount();
 

getWorkBasketSequence
Returns an ordered collection of DKString objects containing the item IDs of the workbaskets in the workflow.
     dkCollection * getWorkBasketSequence();
 

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

setID
Sets the item ID of the workflow.
        void setID(const char * itemIDWF);
 

setName
Sets the name of the workflow.
        void setName(const char * workflow_name);
 

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

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

DK_DL_WF_SAVE_HISTORY
the log will save the entries.

DK_DL_WF_DISCARD_HISTORY
the log will discard the entires up to the last workflow separator.

        void setHistoryDisposition(long history_disposition);
 

setWorkBasketSequence
Sets the sequence of workbaskets in a workflow. The parameter workbasket_sequence is an ordered collection of DKString objects containing the item ID of the workbasket.
        void setWorkBasketSequence(dkCollection * 
                                   workbasket_sequence);
 

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.