|
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.DKWorkBasketDL
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 |
public DKWorkBasketDL(DKWorkFlowServiceDL ws, java.lang.String itemIDWB) throws DKException
ws
- work flow serviceitemIDWB
- workbasket item idpublic DKWorkBasketDL(DKWorkFlowServiceDL ws) throws DKException
ws
- work flow serviceMethod Detail |
public void setDatastore(dkDatastore ds)
public dkDatastore getDatastore()
public void addItem(java.lang.String itemID, int initial_priority, boolean overload) throws DKException, java.lang.Exception
itemID
- item id of document or folderoverload
- indicate action to take if adding overload workbasketinitial_priority
- priority of item in workbasketpublic void removeItem(java.lang.String itemID) throws DKException, java.lang.Exception
itemID
- item id of document or folderpublic java.lang.String getNextHighPriorityItem() throws DKException, java.lang.Exception
public dkCollection listItemIDs(int wip_status) throws DKException, java.lang.Exception
wip_status
- workflow statuspublic dkCollection listWorkManagementInfos(int wip_status) throws DKException, java.lang.Exception
public dkCollection listItemIDsWF(java.lang.String itemIDWF) throws DKException, java.lang.Exception
itemIDWF
- item id of workflowpublic dkCollection listWorkManagementInfosWF(java.lang.String itemIDWF) throws DKException, java.lang.Exception
itemIDWF
- item id of workflowpublic java.lang.String getID()
public java.lang.String getName()
public java.lang.String getAccessList()
public int getLoadLimit()
public boolean getRemoveAfterIndex()
public boolean getSystemControl()
public java.lang.String getUserFunction()
public java.lang.String getUserDll()
public java.lang.String getPrivilegeString()
public dkCollection getAssociatedWorkFlowIDs() throws DKException, java.lang.Exception
public void setID(java.lang.String itemIDWB)
itemIDWB
- workbasket item idpublic void setName(java.lang.String workbasket_name)
workbasket_name
- workbasket namepublic void setAccessList(java.lang.String access_list)
access_list
- workbasket access list namepublic void setLoadLimit(int load_limit)
load_limit
- workbasket load limitpublic void setRemoveAfterIndex(boolean remove_after_index)
remove_after_index
- true after item is indexed and
removed from workbasketpublic void setSystemControl(boolean system_control)
system_control
- true workbasket is system-assigned.public void setUserFunction(java.lang.String user_function)
user_function
- user exit functionpublic void setUserDll(java.lang.String user_dll)
user_dll
- DLL namepublic void add() throws DKException, java.lang.Exception
public void update() throws DKException, java.lang.Exception
public void del() throws DKException, java.lang.Exception
public void retrieve() throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |