Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkListFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkListFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, java.io.Serializable

public class DKWorkListFed
extends java.lang.Object
implements java.io.Serializable, DKConstantFed, DKMessageIdFed

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.

See Also:
Serialized Form

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

DKWorkListFed

public DKWorkListFed(dkWorkFlowServiceFed service,
                     java.lang.String name)
              throws DKException,
                     java.lang.Exception
Constructs a DKWorkListFed object representing the worklist of the specified worklist name.
Parameters:
service - DKWorkFlowServiceFed object.
name - name of worklist.

DKWorkListFed

public DKWorkListFed(dkWorkFlowServiceFed service)
              throws DKException,
                     java.lang.Exception
Constructs a DKWorkListFed object.
Parameters:
service - DKWorkFlowServiceFed object.
Method Detail

getName

public java.lang.String getName()
                         throws DKException,
                                java.lang.Exception
Gets the name of the worklist.
Returns:
name of the worklist.

getDescription

public java.lang.String getDescription()
                                throws DKException,
                                       java.lang.Exception
Gets the description of the worklist.
Returns:
description of the worklist.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved.

getOwner

public java.lang.String getOwner()
                          throws DKException,
                                 java.lang.Exception
Gets the owner of the worklist.
Returns:
the owner of the worklist.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved.

getThreshold

public int getThreshold()
                 throws DKException,
                        java.lang.Exception
Gets the threshold of the worklist.
Returns:
the threshold of the worklsit.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved.

getFilter

public java.lang.String getFilter()
                           throws DKException,
                                  java.lang.Exception
Gets the filter of the worklist.
Returns:
the filter of the worklist.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved.

getSortCriteria

public java.lang.String getSortCriteria()
                                 throws DKException,
                                        java.lang.Exception
Gets the sort criteria of the worklist.
Returns:
the sort criteria of the worklist.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved.

getACLName

public java.lang.String getACLName()
                            throws DKException,
                                   java.lang.Exception
Gets the ACL name of the worklist.
Returns:
the ACL name of the worklist.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved.

setName

public void setName(java.lang.String name)
             throws DKException,
                    java.lang.Exception
Sets the name of the worklist.
Parameters:
name - name of the worklist.

setDescription

public void setDescription(java.lang.String description)
                    throws DKException,
                           java.lang.Exception
Sets the description of the worklist.
Parameters:
description - description of the worklist.

setOwner

public void setOwner(java.lang.String owner_name)
              throws DKException,
                     java.lang.Exception
Sets the owner of the worklist.
Parameters:
owner - owner of the worklist.

setThreshold

public void setThreshold(int threshold)
                  throws DKException,
                         java.lang.Exception
Sets the threshold of the worklist. Use DK_FED_FMC_MAX_RESULTS to return all the results.
Parameters:
threshold - threshold of the worklist.

setFilter

public void setFilter(java.lang.String filter)
               throws DKException,
                      java.lang.Exception
Sets the filter name of the worklist.
Parameters:
filtet - filter of the worklist.

setSortCriteria

public void setSortCriteria(java.lang.String sort_criteria)
                     throws DKException,
                            java.lang.Exception
Sets the sort criteria of the worklist.
Parameters:
sort_criteria - sort criteria of the worklist.

setACLName

public void setACLName(java.lang.String acl_name)
                throws DKException,
                       java.lang.Exception
Sets the ACL name of the worklist.
Parameters:
acl_name - ACL name of the worklist.

listWorkItems

public dkCollection listWorkItems()
                           throws DKException,
                                  java.lang.Exception
Returns a collection of workitems.

The following code assumes WL is a retrieved DKWorkListFed object.

 DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItems();
 
Returns:
a collection of workitems.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the listWorkItems operation fails.

listWorkItemsByTemplate

public dkCollection listWorkItemsByTemplate(java.lang.String template_name)
                                     throws DKException,
                                            java.lang.Exception
Returns a collection of workitems by the specified workflow template name.

The following code assumes WL is a retrieved DKWorkListFed object.

 DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItemsByTemplate();
 
Returns:
a collection of workitems.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the listWorkItemsByTemplate operation fails.

listWorkItemsByNode

public dkCollection listWorkItemsByNode(java.lang.String node_name)
                                 throws DKException,
                                        java.lang.Exception
Returns a collection of workitems by the specified node name.

The following code assumes WL is a retrieved DKWorkListFed object.

 DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItemsByNode();
 
Returns:
a collection of workitems.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the listWorkItemsByNode operation fails.

listWorkItemsByTemplateAndNode

public dkCollection listWorkItemsByTemplateAndNode(java.lang.String template_name,
                                                   java.lang.String node_name)
                                            throws DKException,
                                                   java.lang.Exception
Returns a collection of workitems by the specified workflow template name and node name.

The following code assumes WL is a retrieved DKWorkListFed object.

 DKSequentialCollection coll = (DKSequentialCollection)WL.listWorkItemsByTemplateAndNode();
 
Returns:
a collection of workitems.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the listWorkItemsByTemplateAndNode operation fails.

listProcessNotifications

public dkCollection listProcessNotifications()
                                      throws DKException,
                                             java.lang.Exception
Returns a collection of process notifications represented as DKWorkFlowNotificationFed objects.

The following code assumes WL is a retrieved DKWorkListFed object.

 DKSequentialCollection coll = (DKSequentialCollection)WL.listProcessNotifications();
 
Returns:
a collection of process notifications.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the listProcessNotifications operation fails.

listActivityNotifications

public dkCollection listActivityNotifications()
                                       throws DKException,
                                              java.lang.Exception
Returns a collection of activity notifications represented as DKWorkFlowNotificationFed objects.

The following code assumes WL is a retrieved DKWorkListFed object.

 DKSequentialCollection coll = (DKSequentialCollection)WL.listActivityNotifications();
 
Returns:
a collection of activity notifications.
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the listAvtivityNotifications operation fails.

add

public void add()
         throws DKException,
                java.lang.Exception
Adds a new worklist.

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();
 
Throws:
DKUsageError - if the add operation fails.

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates a worklist.

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();
 
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the update operation fails.

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes a worklist.

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();
 
Throws:
DKUsageError - if the DKWorkListFed object is not retrieved, or the delete operation fails.

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves and refreshes the information of the worklist.

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();
 
Throws:
DKUsageError - if the DKWorkListFed object cannot be retrieved.

EIP Java APIs

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