|
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.DKWorkListFed
The DKWorkListFed is an object oriented representation of a worklist in the system. A worklist is defined in the system, and it is a collection of workitems.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
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.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKWorkListFed(dkWorkFlowServiceFed service)
Constructs a DKWorkListFed object. |
|
DKWorkListFed(dkWorkFlowServiceFed service,
java.lang.String name)
Constructs a DKWorkListFed object representing the worklist of the specified worklist name. |
Method Summary | |
void |
add()
Adds a new worklist. |
void |
del()
Deletes a worklist. |
java.lang.String |
getACLName()
Gets the ACL name of the worklist. |
java.lang.String |
getDescription()
Gets the description of the worklist. |
java.lang.String |
getFilter()
Gets the filter of the worklist. |
java.lang.String |
getName()
Gets the name of the worklist. |
java.lang.String |
getOwner()
Gets the owner of the worklist. |
java.lang.String |
getSortCriteria()
Gets the sort criteria of the worklist. |
int |
getThreshold()
Gets the threshold of the worklist. |
dkCollection |
listActivityNotifications()
Returns a collection of activity notifications represented as DKWorkFlowNotificationFed objects. |
dkCollection |
listProcessNotifications()
Returns a collection of process notifications represented as DKWorkFlowNotificationFed objects. |
dkCollection |
listWorkItems()
Returns a collection of workitems. |
dkCollection |
listWorkItemsByNode(java.lang.String node_name)
Returns a collection of workitems by the specified node name. |
dkCollection |
listWorkItemsByTemplate(java.lang.String template_name)
Returns a collection of workitems by the specified workflow template name. |
dkCollection |
listWorkItemsByTemplateAndNode(java.lang.String template_name,
java.lang.String node_name)
Returns a collection of workitems by the specified workflow template name and node name. |
void |
retrieve()
Retrieves and refreshes the information of the worklist. |
void |
setACLName(java.lang.String acl_name)
Sets the ACL name of the worklist. |
void |
setDescription(java.lang.String description)
Sets the description of the worklist. |
void |
setFilter(java.lang.String filter)
Sets the filter name of the worklist. |
void |
setName(java.lang.String name)
Sets the name of the worklist. |
void |
setOwner(java.lang.String owner_name)
Sets the owner of the worklist. |
void |
setSortCriteria(java.lang.String sort_criteria)
Sets the sort criteria of the worklist. |
void |
setThreshold(int threshold)
Sets the threshold of the worklist. |
void |
update()
Updates a worklist. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkListFed(dkWorkFlowServiceFed service, java.lang.String name) throws DKException, java.lang.Exception
service
- DKWorkFlowServiceFed object.name
- name of worklist.public DKWorkListFed(dkWorkFlowServiceFed service) throws DKException, java.lang.Exception
service
- DKWorkFlowServiceFed object.Method Detail |
public java.lang.String getName() throws DKException, java.lang.Exception
public java.lang.String getDescription() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkListFed object is not retrieved.public java.lang.String getOwner() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkListFed object is not retrieved.public int getThreshold() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkListFed object is not retrieved.public java.lang.String getFilter() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkListFed object is not retrieved.public java.lang.String getSortCriteria() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkListFed object is not retrieved.public java.lang.String getACLName() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkListFed object is not retrieved.public void setName(java.lang.String name) throws DKException, java.lang.Exception
name
- name of the worklist.public void setDescription(java.lang.String description) throws DKException, java.lang.Exception
description
- description of the worklist.public void setOwner(java.lang.String owner_name) throws DKException, java.lang.Exception
owner
- owner of the worklist.public void setThreshold(int threshold) throws DKException, java.lang.Exception
threshold
- threshold of the worklist.public void setFilter(java.lang.String filter) throws DKException, java.lang.Exception
filtet
- filter of the worklist.public void setSortCriteria(java.lang.String sort_criteria) throws DKException, java.lang.Exception
sort_criteria
- sort criteria of the worklist.public void setACLName(java.lang.String acl_name) throws DKException, java.lang.Exception
acl_name
- ACL name of the worklist.public dkCollection listWorkItems() throws DKException, java.lang.Exception
The following code assumes WL is a retrieved DKWorkListFed object.
DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItems();
DKUsageError
- if the DKWorkListFed object is not retrieved, or
the listWorkItems operation fails.public dkCollection listWorkItemsByTemplate(java.lang.String template_name) throws DKException, java.lang.Exception
The following code assumes WL is a retrieved DKWorkListFed object.
DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItemsByTemplate();
DKUsageError
- if the DKWorkListFed object is not retrieved, or
the listWorkItemsByTemplate operation fails.public dkCollection listWorkItemsByNode(java.lang.String node_name) throws DKException, java.lang.Exception
The following code assumes WL is a retrieved DKWorkListFed object.
DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItemsByNode();
DKUsageError
- if the DKWorkListFed object is not retrieved, or
the listWorkItemsByNode operation fails.public dkCollection listWorkItemsByTemplateAndNode(java.lang.String template_name, java.lang.String node_name) throws DKException, java.lang.Exception
The following code assumes WL is a retrieved DKWorkListFed object.
DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItemsByTemplateAndNode();
DKUsageError
- if the DKWorkListFed object is not retrieved, or
the listWorkItemsByTemplateAndNode operation fails.public dkCollection listProcessNotifications() throws DKException, java.lang.Exception
The following code assumes WL is a retrieved DKWorkListFed object.
DKSequentialCollection coll = (DKSequentialCollection)WL.listProcessNotifications();
DKUsageError
- if the DKWorkListFed object is not retrieved, or
the listProcessNotifications operation fails.public dkCollection listActivityNotifications() throws DKException, java.lang.Exception
The following code assumes WL is a retrieved DKWorkListFed object.
DKSequentialCollection coll = (DKSequentialCollection)WL.listActivityNotifications();
DKUsageError
- if the DKWorkListFed object is not retrieved, or
the listAvtivityNotifications operation fails.public void add() throws DKException, java.lang.Exception
The following code assumes svWF is an existing DKWorkFlowServiceFed object. A DKWorkListFed object WL is created. The name, description, and threshold of the DKWorkListFed object are specified. The add method creates the worklist called "WL001".
DKWorkListFed WL = new DKWorkListFed(svWF); WL.setName("WL001"); WL.setDescription("A worklist"); WL.setThreshold(100); WL.add();
DKUsageError
- if the add operation fails.public void update() throws DKException, java.lang.Exception
The following code assumes svWF is an existing DKWorkFlowServiceFed object. A DKWorkListFed object WL called "WL001" is created. The threshold of the DKWorkListFed object is set to 200. The update method modifies the worklist.
DKWorkListFed WL = new DKWorkListFed(svWF, "WL001"); WL.retrieve(); WL.setThreshold(200); WL.update();
DKUsageError
- if the DKWorkListFed object is not retrieved,
or the update operation fails.public void del() throws DKException, java.lang.Exception
The following code assumes svWF is an existing DKWorkFlowServiceFed object. A DKWorkListFed object WL called "WL001" is created. The del method deletes the worklist.
DKWorkListFed WL = new DKWorkListFed(svWF, "WL001"); WL.retrieve(); WL.delete();
DKUsageError
- if the DKWorkListFed object is not retrieved,
or the delete operation fails.public void retrieve() throws DKException, java.lang.Exception
The following code assumes svWF is an existing DKWorkFlowServiceFed object. A DKWorkListFed object WL called "WL001" is created. The retrieve method retrieves the worklist.
DKWorkListFed WL = new DKWorkListFed(svWF, "WL001"); WL.retrieve();
DKUsageError
- if the DKWorkListFed object cannot be retrieved.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |