Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowServiceDL

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

public class DKWorkFlowServiceDL
extends java.lang.Object
implements dkWorkFlowService, 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
DKWorkFlowServiceDL(dkDatastore ds)
          Constructs a work flow service for DL
 
Method Summary
 void changeWorkFlowItem(java.lang.String itemID, java.lang.String itemIDWF)
          Change workflow of an item
 void completeWorkFlowItem(java.lang.String itemID)
          Remove item from its workflow and sets item status to workflow completion
 void connect(java.lang.String workflow_service_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string)
          Connects to a work flow service
 DKHandle connection()
          Gets the connection handle
 void disconnect()
          Disconnects from the workflow service
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 DKWorkBasketDL getNextWorkBasket(java.lang.String itemID)
          Gets next workbasket in workflow of the specified item.
 java.lang.String getNextWorkBasketID(java.lang.String itemID)
          Get item id of next workbasket in workflow of the specified item.
 int getWorkBasketItemPriority(java.lang.String itemID)
          Gets priority of the specified item.
 boolean isConnected()
          Status of connection
 int itemIDType(java.lang.String itemID)
          Get type of item id
 dkCollection listWorkBasketIDs()
          List item ids of every workbasket in system
 dkCollection listWorkBaskets()
          List every workbasket in system
 dkCollection listWorkFlowIDs()
          List item ids of every workflow in system
 dkCollection listWorkFlows()
          List every workflow in system
 void removeWorkFlowItem(java.lang.String itemID)
          Remove item from its workflow
 void routeWipItem(java.lang.String itemID, java.lang.String itemIDWB, boolean overload, int priority)
          Moves an item from current workbasket to another workbasket
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setWorkBasketItemPriority(java.lang.String itemID, int priority)
          Sets priority of the specified item.
 void startWorkFlowItem(java.lang.String itemID, java.lang.String itemIDWF, java.lang.String itemIDWB, boolean overload, int initial_priority)
          Starts a document or folder in a workflow
 java.lang.String userName()
          Gets the user name
 java.lang.String workflowServiceName()
          Gets workflow service name
 java.lang.String workflowServiceType()
          Gets workflow service type
 DKWorkManagementInfoDL workManagementInfo(java.lang.String itemID)
          Get work managem information of the specified item
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkFlowServiceDL

public DKWorkFlowServiceDL(dkDatastore ds)
                    throws DKException
Constructs a work flow service for DL
Parameters:
ds - datastore
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

connect

public void connect(java.lang.String workflow_service_name,
                    java.lang.String user_name,
                    java.lang.String authentication,
                    java.lang.String connect_string)
             throws DKException
Connects to a work flow service
Specified by:
connect in interface dkWorkFlowService
Parameters:
workflow_service_name - the work flow service
user_name - the user name used for connection
authentication - the authentication used for connection
connect_string - the connect string used for connection. This is used to provide additional connection options.

disconnect

public void disconnect()
                throws DKException
Disconnects from the workflow service
Specified by:
disconnect in interface dkWorkFlowService

workflowServiceType

public java.lang.String workflowServiceType()
                                     throws java.lang.Exception
Gets workflow service type
Specified by:
workflowServiceType in interface dkWorkFlowService

workflowServiceName

public java.lang.String workflowServiceName()
                                     throws java.lang.Exception
Gets workflow service name
Specified by:
workflowServiceName in interface dkWorkFlowService

userName

public java.lang.String userName()
                          throws java.lang.Exception
Gets the user name
Specified by:
userName in interface dkWorkFlowService

isConnected

public boolean isConnected()
                    throws DKException,
                           java.lang.Exception
Status of connection
Specified by:
isConnected in interface dkWorkFlowService

connection

public DKHandle connection()
                    throws DKException,
                           java.lang.Exception
Gets the connection handle
Specified by:
connection in interface dkWorkFlowService

startWorkFlowItem

public void startWorkFlowItem(java.lang.String itemID,
                              java.lang.String itemIDWF,
                              java.lang.String itemIDWB,
                              boolean overload,
                              int initial_priority)
                       throws DKException,
                              java.lang.Exception
Starts a document or folder in a workflow
Parameters:
itemID - item id of document or folder
itemIDWF - item id of work flow
itemIDWB - item id of work basket or NULL for first workbasket
overload - indicate action to take if adding overload workbasket
initial_priority - priority of item in workbasket

changeWorkFlowItem

public void changeWorkFlowItem(java.lang.String itemID,
                               java.lang.String itemIDWF)
                        throws DKException,
                               java.lang.Exception
Change workflow of an item
Parameters:
itemID - item id of document or folder
itemIDWF - item id of work flow

removeWorkFlowItem

public void removeWorkFlowItem(java.lang.String itemID)
                        throws DKException,
                               java.lang.Exception
Remove item from its workflow
Parameters:
itemID - item id of document or folder

completeWorkFlowItem

public void completeWorkFlowItem(java.lang.String itemID)
                          throws DKException,
                                 java.lang.Exception
Remove item from its workflow and sets item status to workflow completion
Parameters:
itemID - item id of document or folder

routeWipItem

public void routeWipItem(java.lang.String itemID,
                         java.lang.String itemIDWB,
                         boolean overload,
                         int priority)
                  throws DKException,
                         java.lang.Exception
Moves an item from current workbasket to another workbasket
Parameters:
itemID - item id of document or folder
itemIDWB - item id of work basket or NULL for first workbasket
overload - indicate action to take if adding overload workbasket
initial_priority - priority of item in workbasket

getNextWorkBasketID

public java.lang.String getNextWorkBasketID(java.lang.String itemID)
                                     throws DKException,
                                            java.lang.Exception
Get item id of next workbasket in workflow of the specified item.
Parameters:
itemID - item id of document or folder
Returns:
next workbasket item id

getNextWorkBasket

public DKWorkBasketDL getNextWorkBasket(java.lang.String itemID)
                                 throws DKException,
                                        java.lang.Exception
Gets next workbasket in workflow of the specified item.
Parameters:
itemID - item id of document or folder
Returns:
next workbasket

getWorkBasketItemPriority

public int getWorkBasketItemPriority(java.lang.String itemID)
                              throws DKException,
                                     java.lang.Exception
Gets priority of the specified item.
Parameters:
itemID - item id of document or folder
Returns:
workbasket priority

setWorkBasketItemPriority

public void setWorkBasketItemPriority(java.lang.String itemID,
                                      int priority)
                               throws DKException,
                                      java.lang.Exception
Sets priority of the specified item.
Parameters:
itemID - item id of document or folder
priority - priority of item in workbasket

listWorkFlowIDs

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

listWorkFlows

public dkCollection listWorkFlows()
                           throws DKException,
                                  java.lang.Exception
List every workflow in system
Returns:
collection of workflows

listWorkBasketIDs

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

listWorkBaskets

public dkCollection listWorkBaskets()
                             throws DKException,
                                    java.lang.Exception
List every workbasket in system
Returns:
collection of work baskets

itemIDType

public int itemIDType(java.lang.String itemID)
               throws DKException,
                      java.lang.Exception
Get type of item id
Returns:
item id type

workManagementInfo

public DKWorkManagementInfoDL workManagementInfo(java.lang.String itemID)
                                          throws DKException,
                                                 java.lang.Exception
Get work managem information of the specified item
Parameters:
itemID - item id of a document or folder
Returns:
work management information

EIP Java APIs

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