|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKWorkFlowServiceDL
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 |
public DKWorkFlowServiceDL(dkDatastore ds) throws DKException
ds
- datastoreMethod Detail |
public void setDatastore(dkDatastore ds)
public dkDatastore getDatastore()
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
connect
in interface dkWorkFlowService
workflow_service_name
- the work flow serviceuser_name
- the user name used for connectionauthentication
- the authentication used for connectionconnect_string
- the connect string used for connection. This
is used to provide additional connection options.public void disconnect() throws DKException
disconnect
in interface dkWorkFlowService
public java.lang.String workflowServiceType() throws java.lang.Exception
workflowServiceType
in interface dkWorkFlowService
public java.lang.String workflowServiceName() throws java.lang.Exception
workflowServiceName
in interface dkWorkFlowService
public java.lang.String userName() throws java.lang.Exception
userName
in interface dkWorkFlowService
public boolean isConnected() throws DKException, java.lang.Exception
isConnected
in interface dkWorkFlowService
public DKHandle connection() throws DKException, java.lang.Exception
connection
in interface dkWorkFlowService
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
itemID
- item id of document or folderitemIDWF
- item id of work flowitemIDWB
- item id of work basket or NULL for first workbasketoverload
- indicate action to take if adding overload workbasketinitial_priority
- priority of item in workbasketpublic void changeWorkFlowItem(java.lang.String itemID, java.lang.String itemIDWF) throws DKException, java.lang.Exception
itemID
- item id of document or folderitemIDWF
- item id of work flowpublic void removeWorkFlowItem(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of document or folderpublic void completeWorkFlowItem(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of document or folderpublic void routeWipItem(java.lang.String itemID, java.lang.String itemIDWB, boolean overload, int priority) throws DKException, java.lang.Exception
itemID
- item id of document or folderitemIDWB
- item id of work basket or NULL for first workbasketoverload
- indicate action to take if adding overload workbasketinitial_priority
- priority of item in workbasketpublic java.lang.String getNextWorkBasketID(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of document or folderpublic DKWorkBasketDL getNextWorkBasket(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of document or folderpublic int getWorkBasketItemPriority(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of document or folderpublic void setWorkBasketItemPriority(java.lang.String itemID, int priority) throws DKException, java.lang.Exception
itemID
- item id of document or folderpriority
- priority of item in workbasketpublic dkCollection listWorkFlowIDs() throws DKException, java.lang.Exception
public dkCollection listWorkFlows() throws DKException, java.lang.Exception
public dkCollection listWorkBasketIDs() throws DKException, java.lang.Exception
public dkCollection listWorkBaskets() throws DKException, java.lang.Exception
public int itemIDType(java.lang.String itemID) throws DKException, java.lang.Exception
public DKWorkManagementInfoDL workManagementInfo(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of a document or folder
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |