Enterprise Information Portal APIs

com.ibm.mm.beans.workflow
Class CMBDocRoutingQueryServiceICM

java.lang.Object
  |
  +--com.ibm.mm.beans.workflow.CMBDocRoutingQueryServiceICM
All Implemented Interfaces:
CMBConnectionReplyListener, java.util.EventListener, java.io.Serializable

public class CMBDocRoutingQueryServiceICM
extends java.lang.Object
implements java.io.Serializable, CMBConnectionReplyListener

This bean provides ICM Document Routing query services. You can obtain an instance of this bean from CMBConnection.

See Also:
CMBConnection, Serialized Form

Constructor Summary
CMBDocRoutingQueryServiceICM()
          Creates a new instance of CMBDocRoutingQueryServiceICM object with default values
 
Method Summary
 void addCMBExceptionListener(CMBExceptionListener alistener)
          CMBExceptionEvent registration method.
 void addCMBTraceListener(CMBTraceListener alistener)
          CMBTraceEvent registration method.
 CMBConnection getConnection()
          Returns the connection bean reference.
 int getCount(java.lang.String worklistName, java.lang.String owner)
          Get the number of work packages in a worklist for a given owner.
 CMBWorkPackageICM getNextWorkPackage(java.lang.String worklistName, java.lang.String owner)
          Get the next work package in the specified worklist for the specified owner and check out the referenced item.
 java.lang.String getNextWorkPackagePidString(java.lang.String worklistName, java.lang.String owner)
          Get the next work package pid string for the specified work list name and owner and check out the referenced ite id.
 CMBProcessICM getProcess(java.lang.String processName)
          Get a process.
 java.util.Collection getProcesses()
          Get processes.
 java.lang.String[] getProcessNames()
          Get process names
 java.util.Collection getUsers(java.lang.String aclName)
          Get the users for the specifed acl name.
 CMBWorkListICM getWorkList(java.lang.String worklistName)
          Get worklist.
 java.lang.String[] getWorkListNames()
          Get worklist names.
 java.util.Collection getWorkLists()
          Get worklists.
 CMBWorkNodeICM getWorkNode(java.lang.String workNodeName)
          Get a work node.
 java.lang.String[] getWorkNodeNames()
          Get work node names.
 java.util.Collection getWorkNodes()
          Get work nodes.
 CMBWorkPackageICM getWorkPackage(java.lang.String workpackagePID, boolean checkOut)
          Get a work package specified by the work package pid and specify if the item id referenced in the work package is to be checked out.
 java.lang.String getWorkPackageOwner(java.lang.String workpackagePID)
          Get the owner of the work package specified by the work package pid
 java.lang.String[] getWorkPackagePidStrings(java.lang.String worklistName, java.lang.String owner)
          Get the work package pid strings for the specified work list name and owner.
 java.lang.String[] getWorkPackagePidStringsWithItem(java.lang.String itemID)
          Get the work package pid strings which contain the specifed item id.
 int getWorkPackagePriority(java.lang.String workpackagePID)
          Get the priority of a work package
 boolean isTraceEnabled()
          Property for trace enabled
 void onCMBConnectionReply(CMBConnectionReplyEvent evt)
          Implementation of Connection reply service method.
 void removeCMBExceptionListener(CMBExceptionListener alistener)
          CMBExceptionEvent unregistration method.
 void removeCMBTraceListener(CMBTraceListener alistener)
          CMBTraceEvent unregistration method.
 void setConnection(CMBConnection newConnBean)
          Sets the connection bean reference.
 void setTraceEnabled(boolean enabled)
          Sets the trace property value.
 void vetoableChange(java.beans.PropertyChangeEvent evt)
          Check if property allows to be changed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBDocRoutingQueryServiceICM

public CMBDocRoutingQueryServiceICM()
Creates a new instance of CMBDocRoutingQueryServiceICM object with default values
Method Detail

setConnection

public void setConnection(CMBConnection newConnBean)
Sets the connection bean reference.
Parameters:
newConnBean - the reference to the CMBConnection object.

getConnection

public CMBConnection getConnection()
Returns the connection bean reference.
Returns:
the reference to the CMBConnection object.

isTraceEnabled

public boolean isTraceEnabled()
Property for trace enabled
Returns:
true if trace is enabled, false otherwise

setTraceEnabled

public void setTraceEnabled(boolean enabled)
Sets the trace property value.
Parameters:
enabled - new trace value

addCMBExceptionListener

public void addCMBExceptionListener(CMBExceptionListener alistener)
CMBExceptionEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
alistener - listener to be registered

removeCMBExceptionListener

public void removeCMBExceptionListener(CMBExceptionListener alistener)
CMBExceptionEvent unregistration method.
Parameters:
alistener - listener to be unregistered

addCMBTraceListener

public void addCMBTraceListener(CMBTraceListener alistener)
CMBTraceEvent registration method. It ignores a registration request if the listener is already registered.
Parameters:
alistener - listener to be registered

removeCMBTraceListener

public void removeCMBTraceListener(CMBTraceListener alistener)
CMBTraceEvent unregistration method.
Parameters:
alistener - listener to be unregistered

vetoableChange

public void vetoableChange(java.beans.PropertyChangeEvent evt)
                    throws java.beans.PropertyVetoException
Check if property allows to be changed.
Parameters:
evt - a property changed event
Throws:
java.beans.PropertyVetoException - if property value is invalid

getNextWorkPackage

public CMBWorkPackageICM getNextWorkPackage(java.lang.String worklistName,
                                            java.lang.String owner)
                                     throws CMBException
Get the next work package in the specified worklist for the specified owner and check out the referenced item. This method will return the next work package where the referenced item in the work package is not checked out by another user. The work package returned is also based on how the System Administrator defined the worklist filter for owner. See the APG for details. If this method is called again and the list of work packages have remained the same, the same work package is returned. Note: the operations which change the list of work packages are start, continue, terminate, suspend, and resume.
Parameters:
worklistName - the name of the worklist
owner - the owner
Returns:
CMBWorkPackageICM object, the next work package in the worklist
Throws:
CMBException -  

getWorkPackageOwner

public java.lang.String getWorkPackageOwner(java.lang.String workpackagePID)
                                     throws CMBException
Get the owner of the work package specified by the work package pid
Parameters:
workpackagePID - the pid of the work package
Returns:
owner the owner of the work package
Throws:
CMBException -  

getWorkPackage

public CMBWorkPackageICM getWorkPackage(java.lang.String workpackagePID,
                                        boolean checkOut)
                                 throws CMBException
Get a work package specified by the work package pid and specify if the item id referenced in the work package is to be checked out.
Parameters:
workpackagePID - the pid of the work package to be returned
checkOut - checkOut the item defined in the work package, true or false
Returns:
CMBWorkPackageICM object
Throws:
CMBException -  

getWorkPackagePidStrings

public java.lang.String[] getWorkPackagePidStrings(java.lang.String worklistName,
                                                   java.lang.String owner)
                                            throws CMBException
Get the work package pid strings for the specified work list name and owner. The work package pid strings returned is based on how the System Administrator defined the worklist filter for owner. See the APG for details.
Parameters:
worklistName - the name of the worklist
owner - the owner
Returns:
the pid strings
Throws:
CMBException -  

getUsers

public java.util.Collection getUsers(java.lang.String aclName)
                              throws CMBException
Get the users for the specifed acl name.
Parameters:
aclName - the aclName
Returns:
users a collection of Strings, the users.
Throws:
CMBException -  

getWorkPackagePidStringsWithItem

public java.lang.String[] getWorkPackagePidStringsWithItem(java.lang.String itemID)
                                                    throws CMBException
Get the work package pid strings which contain the specifed item id.
Parameters:
itemID - the persistent id of the item
Returns:
array of strings, the work package pid strings which contain the item.
Throws:
CMBException -  

getProcess

public CMBProcessICM getProcess(java.lang.String processName)
                         throws CMBException
Get a process.
Parameters:
processName - the process name
Returns:
CMBProcessICM object. A null is returned if the process does not exist
Throws:
CMBException -  

getCount

public int getCount(java.lang.String worklistName,
                    java.lang.String owner)
             throws CMBException
Get the number of work packages in a worklist for a given owner. The count returned is based on how the System Administrator defined the worklist filter for owner. See the APG for details.
Parameters:
worklistName - the name of the worklist
owner - the owner
Returns:
number of work packages in worklist specified by worklist name
Throws:
CMBException -  

getWorkPackagePriority

public int getWorkPackagePriority(java.lang.String workpackagePID)
                           throws CMBException
Get the priority of a work package
Parameters:
workpackagePID - the work package pid
Returns:
the priority of the work package for the given work package pid
Throws:
CMBException -  

getWorkNode

public CMBWorkNodeICM getWorkNode(java.lang.String workNodeName)
                           throws CMBException
Get a work node.
Parameters:
workNodeName - the name of the work node to be returned.
Returns:
CMBWorkNodeICM object, the work node specfied by work node name. A null is returned if the work node name does not exist.
Throws:
CMBException -  

getWorkNodeNames

public java.lang.String[] getWorkNodeNames()
                                    throws CMBException
Get work node names.
Returns:
an array of strings, the work node names
Throws:
CMBException -  

getProcesses

public java.util.Collection getProcesses()
                                  throws CMBException
Get processes.
Returns:
a collection of CMBProcessICM objects.
Throws:
CMBException -  

getWorkNodes

public java.util.Collection getWorkNodes()
                                  throws CMBException
Get work nodes.
Returns:
a collection of CMBWorkNodeICM objects.
Throws:
CMBException -  

getWorkLists

public java.util.Collection getWorkLists()
                                  throws CMBException
Get worklists.
Returns:
a collection of CMBWorkListICM objects.
Throws:
CMBException -  

getWorkList

public CMBWorkListICM getWorkList(java.lang.String worklistName)
                           throws CMBException
Get worklist.
Parameters:
worklistName - the worklist name
Returns:
a CMBWorkListICM object, the worklist specified by worklist name.
Throws:
CMBException -  

getWorkListNames

public java.lang.String[] getWorkListNames()
                                    throws CMBException
Get worklist names.
Returns:
an array of strings, the worklist names
Throws:
CMBException -  

getProcessNames

public java.lang.String[] getProcessNames()
                                   throws CMBException
Get process names
Returns:
an array of strings, the process names
Throws:
CMBException -  

getNextWorkPackagePidString

public java.lang.String getNextWorkPackagePidString(java.lang.String worklistName,
                                                    java.lang.String owner)
                                             throws CMBException
Get the next work package pid string for the specified work list name and owner and check out the referenced ite id. This method will return the next work package pid string for the given work list name and owner, where the referenced item in the work package is not checked out by another user. The work package returned is also based on how the System Administrator defined the worklist filter for owner. See the APG for details. If this method is called again and the list of work packages have remained the same, the same work package is returned. Note: the operations which change the list of work packages are: start, continue, terminate, suspend, and resume.
Parameters:
worklistName - the name of the worklist
owner - the owner
Returns:
the pid string of the next work package in the specified worklist. The item associated with the work package is checked out.
Throws:
CMBException -  

onCMBConnectionReply

public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
Implementation of Connection reply service method.
Specified by:
onCMBConnectionReply in interface CMBConnectionReplyListener
Parameters:
evt - a CMBConnectionReplyEvent

EIP JavaBeans

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