Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowDL

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowDL
All Implemented Interfaces:
DKConstant, DKConstantDL, DKMessageId, DKMessageIdDL

public class DKWorkFlowDL
extends java.lang.Object
implements DKConstantDL, DKMessageIdDL


Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDL
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKWorkFlowDL(DKWorkFlowServiceDL ws)
          Constructs a work flow for DL
DKWorkFlowDL(DKWorkFlowServiceDL ws, java.lang.String itemIDWF)
          Constructs a work flow for DL
 
Method Summary
 void add()
          Add workflow to system
 void del()
          Delete workflow from system
 java.lang.String getAccessList()
          Get workflow access list name
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 int getHistoryDisposition()
          Get disposition of history log
 java.lang.String getID()
          Get workflow item id
 int getItemCount()
          Get number of items in workflow
 java.lang.String getName()
          Get workflow name
 java.lang.String getPrivilegeString()
          Get privilege string of the user
 int getWorkBasketCount()
          Get number of work baskets in workflow
 dkCollection getWorkBasketSequence()
          Get ordered collection of the workbasket item ids in workflow
 dkCollection listItemIDs()
          List item ids (documents or folders) in this workflow
 dkCollection listWorkBasketIDs()
          List workbasket item ids in workflow
 dkCollection listWorkBaskets()
          List workbasket item in workflow
 dkCollection listWorkManagementInfos()
          List work management information objects in workflow
 void retrieve()
          Retrieve workflow from system
 void setAccessList(java.lang.String access_list)
          Set workflow access list
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setHistoryDisposition(int history_disposition)
          Set workflow disposition of history log
 void setID(java.lang.String itemIDWF)
          Set workflow item id
 void setName(java.lang.String workflow_name)
          Set workflow name
 void setWorkBasketSequence(dkCollection workbasket_sequence)
          Set sequence of workbaskets in a workflow
 void update()
          Update workflow in system
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkFlowDL

public DKWorkFlowDL(DKWorkFlowServiceDL ws,
                    java.lang.String itemIDWF)
             throws DKException
Constructs a work flow for DL
Parameters:
ws - work flow service
itemIDWF - work flow item id

DKWorkFlowDL

public DKWorkFlowDL(DKWorkFlowServiceDL ws)
             throws DKException
Constructs a work flow for DL
Parameters:
ws - work flow service
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

listItemIDs

public dkCollection listItemIDs()
                         throws DKException,
                                java.lang.Exception
List item ids (documents or folders) in this workflow
Returns:
collection of item ids

listWorkManagementInfos

public dkCollection listWorkManagementInfos()
                                     throws DKException,
                                            java.lang.Exception
List work management information objects in workflow
Returns:
collection of work management information objects in workflow

listWorkBasketIDs

public dkCollection listWorkBasketIDs()
                               throws DKException,
                                      java.lang.Exception
List workbasket item ids in workflow
Returns:
collection of workbasket item ids in workflow

listWorkBaskets

public dkCollection listWorkBaskets()
                             throws DKException,
                                    java.lang.Exception
List workbasket item in workflow
Returns:
collection of workbasket item in workflow

getID

public java.lang.String getID()
Get workflow item id
Returns:
workflow item id

getName

public java.lang.String getName()
Get workflow name
Returns:
workflow name

getAccessList

public java.lang.String getAccessList()
Get workflow access list name
Returns:
workflow access list name

getHistoryDisposition

public int getHistoryDisposition()
Get disposition of history log
Returns:
dispostion of history log

getItemCount

public int getItemCount()
Get number of items in workflow
Returns:
number of items in workflow

getWorkBasketCount

public int getWorkBasketCount()
Get number of work baskets in workflow
Returns:
number of work baskets in workflow

getWorkBasketSequence

public dkCollection getWorkBasketSequence()
                                   throws DKException,
                                          java.lang.Exception
Get ordered collection of the workbasket item ids in workflow
Returns:
ordered collection of workbasket item ids

getPrivilegeString

public java.lang.String getPrivilegeString()
                                    throws DKException,
                                           java.lang.Exception
Get privilege string of the user
Returns:
privilege string

setID

public void setID(java.lang.String itemIDWF)
           throws DKException,
                  java.lang.Exception
Set workflow item id
Parameters:
itemIDWF - workflow item id

setName

public void setName(java.lang.String workflow_name)
             throws DKException,
                    java.lang.Exception
Set workflow name
Parameters:
workflow_name - workflow name

setAccessList

public void setAccessList(java.lang.String access_list)
                   throws DKException,
                          java.lang.Exception
Set workflow access list
Parameters:
access_list - workflow access list name

setHistoryDisposition

public void setHistoryDisposition(int history_disposition)
                           throws DKException,
                                  java.lang.Exception
Set workflow disposition of history log
Parameters:
history_dispostion - dispostion of history log

setWorkBasketSequence

public void setWorkBasketSequence(dkCollection workbasket_sequence)
                           throws DKException,
                                  java.lang.Exception
Set sequence of workbaskets in a workflow
Parameters:
workbasket_sequence - workbasket sequence

add

public void add()
         throws DKException,
                java.lang.Exception
Add workflow to system

update

public void update()
            throws DKException,
                   java.lang.Exception
Update workflow in system

del

public void del()
         throws DKException,
                java.lang.Exception
Delete workflow from system

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieve workflow from system

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.