Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkBasketDL

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

public class DKWorkBasketDL
extends java.lang.Object
implements DKConstantDL, DKMessageIdDL, java.io.Serializable

See Also:
Serialized Form

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
DKWorkBasketDL(DKWorkFlowServiceDL ws)
          Constructs a work basket for DL
DKWorkBasketDL(DKWorkFlowServiceDL ws, java.lang.String itemIDWB)
          Constructs a work basket for DL
 
Method Summary
 void add()
          Add workbasket to system
 void addItem(java.lang.String itemID, int initial_priority, boolean overload)
          Add item (a document or folder) to a workbasket
 void del()
          Delete workbasket from system
 java.lang.String getAccessList()
          Get workbasket access list name
 dkCollection getAssociatedWorkFlowIDs()
          List item ids of workflow that are associated with this workbasket
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getID()
          Get workbasket item id
 int getLoadLimit()
          Get workbasket load limit
 java.lang.String getName()
          Get workbasket name
 java.lang.String getNextHighPriorityItem()
          Gets the highest priority item in workbasket
 java.lang.String getPrivilegeString()
          Get privilege string of user
 boolean getRemoveAfterIndex()
          Indicator if system will remove item from workbasket after indexed
 boolean getSystemControl()
          Indicator if system controls item priority within workbasket
 java.lang.String getUserDll()
          Get DLL name that contains user exit function
 java.lang.String getUserFunction()
          Get user exit function
 dkCollection listItemIDs(int wip_status)
          Based on status get a list of item ids
 dkCollection listItemIDsWF(java.lang.String itemIDWF)
          Based on workflow get a list of item ids in the workbasket
 dkCollection listWorkManagementInfos(int wip_status)
          Based on status get a list of work management information objects
 dkCollection listWorkManagementInfosWF(java.lang.String itemIDWF)
          Based on workflow get a list of work management information objects
 void removeItem(java.lang.String itemID)
          Remove an item (a document or folder) from a workbasket
 void retrieve()
          Retrieve workbasket from system
 void setAccessList(java.lang.String access_list)
          Set workbasket access list name
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setID(java.lang.String itemIDWB)
          Set workbasket item id
 void setLoadLimit(int load_limit)
          Set workbasket load limit
 void setName(java.lang.String workbasket_name)
          Set workbasket name
 void setRemoveAfterIndex(boolean remove_after_index)
          Set indicator if system will remove item from workbasket after indexed
 void setSystemControl(boolean system_control)
          Set indicator if system controls item priority within workbasket
 void setUserDll(java.lang.String user_dll)
          Set DLL name that contains user exit function
 void setUserFunction(java.lang.String user_function)
          Set user exit function
 void update()
          Update workbasket from system
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkBasketDL

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

DKWorkBasketDL

public DKWorkBasketDL(DKWorkFlowServiceDL ws)
               throws DKException
Constructs a work basket 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

addItem

public void addItem(java.lang.String itemID,
                    int initial_priority,
                    boolean overload)
             throws DKException,
                    java.lang.Exception
Add item (a document or folder) to a workbasket
Parameters:
itemID - item id of document or folder
overload - indicate action to take if adding overload workbasket
initial_priority - priority of item in workbasket

removeItem

public void removeItem(java.lang.String itemID)
                throws DKException,
                       java.lang.Exception
Remove an item (a document or folder) from a workbasket
Parameters:
itemID - item id of document or folder

getNextHighPriorityItem

public java.lang.String getNextHighPriorityItem()
                                         throws DKException,
                                                java.lang.Exception
Gets the highest priority item in workbasket
Returns:
highest priority item id

listItemIDs

public dkCollection listItemIDs(int wip_status)
                         throws DKException,
                                java.lang.Exception
Based on status get a list of item ids
Parameters:
wip_status - workflow status
Returns:
collection of item ids

listWorkManagementInfos

public dkCollection listWorkManagementInfos(int wip_status)
                                     throws DKException,
                                            java.lang.Exception
Based on status get a list of work management information objects
Returns:
collection of work management information objects

listItemIDsWF

public dkCollection listItemIDsWF(java.lang.String itemIDWF)
                           throws DKException,
                                  java.lang.Exception
Based on workflow get a list of item ids in the workbasket
Parameters:
itemIDWF - item id of workflow
Returns:
collection of item ids

listWorkManagementInfosWF

public dkCollection listWorkManagementInfosWF(java.lang.String itemIDWF)
                                       throws DKException,
                                              java.lang.Exception
Based on workflow get a list of work management information objects
Parameters:
itemIDWF - item id of workflow
Returns:
collection of work management information objects

getID

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

getName

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

getAccessList

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

getLoadLimit

public int getLoadLimit()
Get workbasket load limit
Returns:
workbasket load limit

getRemoveAfterIndex

public boolean getRemoveAfterIndex()
Indicator if system will remove item from workbasket after indexed
Returns:
true after item is indexed and removed from workbasket

getSystemControl

public boolean getSystemControl()
Indicator if system controls item priority within workbasket
Returns:
true workbasket is system-assigned.

getUserFunction

public java.lang.String getUserFunction()
Get user exit function
Returns:
user exit function

getUserDll

public java.lang.String getUserDll()
Get DLL name that contains user exit function
Returns:
DLL name

getPrivilegeString

public java.lang.String getPrivilegeString()
Get privilege string of user
Returns:
privilege string

getAssociatedWorkFlowIDs

public dkCollection getAssociatedWorkFlowIDs()
                                      throws DKException,
                                             java.lang.Exception
List item ids of workflow that are associated with this workbasket
Returns:
collection of item ids

setID

public void setID(java.lang.String itemIDWB)
Set workbasket item id
Parameters:
itemIDWB - workbasket item id

setName

public void setName(java.lang.String workbasket_name)
Set workbasket name
Parameters:
workbasket_name - workbasket name

setAccessList

public void setAccessList(java.lang.String access_list)
Set workbasket access list name
Parameters:
access_list - workbasket access list name

setLoadLimit

public void setLoadLimit(int load_limit)
Set workbasket load limit
Parameters:
load_limit - workbasket load limit

setRemoveAfterIndex

public void setRemoveAfterIndex(boolean remove_after_index)
Set indicator if system will remove item from workbasket after indexed
Parameters:
remove_after_index - true after item is indexed and removed from workbasket

setSystemControl

public void setSystemControl(boolean system_control)
Set indicator if system controls item priority within workbasket
Parameters:
system_control - true workbasket is system-assigned.

setUserFunction

public void setUserFunction(java.lang.String user_function)
Set user exit function
Parameters:
user_function - user exit function

setUserDll

public void setUserDll(java.lang.String user_dll)
Set DLL name that contains user exit function
Parameters:
user_dll - DLL name

add

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

update

public void update()
            throws DKException,
                   java.lang.Exception
Update workbasket from system

del

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

retrieve

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

EIP Java APIs

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