|
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.beans.workflow.CMBDocRoutingQueryServiceICM
This bean provides ICM Document Routing query services. You can obtain an instance of this bean from CMBConnection.
CMBConnection
, Serialized FormConstructor 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 |
public CMBDocRoutingQueryServiceICM()
Method Detail |
public void setConnection(CMBConnection newConnBean)
newConnBean
- the reference to the CMBConnection object.public CMBConnection getConnection()
public boolean isTraceEnabled()
public void setTraceEnabled(boolean enabled)
enabled
- new trace valuepublic void addCMBExceptionListener(CMBExceptionListener alistener)
alistener
- listener to be registeredpublic void removeCMBExceptionListener(CMBExceptionListener alistener)
alistener
- listener to be unregisteredpublic void addCMBTraceListener(CMBTraceListener alistener)
alistener
- listener to be registeredpublic void removeCMBTraceListener(CMBTraceListener alistener)
alistener
- listener to be unregisteredpublic void vetoableChange(java.beans.PropertyChangeEvent evt) throws java.beans.PropertyVetoException
evt
- a property changed eventjava.beans.PropertyVetoException
- if property value is invalidpublic CMBWorkPackageICM getNextWorkPackage(java.lang.String worklistName, java.lang.String owner) throws CMBException
worklistName
- the name of the worklistowner
- the ownerCMBException
- public java.lang.String getWorkPackageOwner(java.lang.String workpackagePID) throws CMBException
workpackagePID
- the pid of the work packageCMBException
- public CMBWorkPackageICM getWorkPackage(java.lang.String workpackagePID, boolean checkOut) throws CMBException
workpackagePID
- the pid of the work package to be returnedcheckOut
- checkOut the item defined in the work package, true or falseCMBException
- public java.lang.String[] getWorkPackagePidStrings(java.lang.String worklistName, java.lang.String owner) throws CMBException
worklistName
- the name of the worklistowner
- the ownerCMBException
- public java.util.Collection getUsers(java.lang.String aclName) throws CMBException
aclName
- the aclNameCMBException
- public java.lang.String[] getWorkPackagePidStringsWithItem(java.lang.String itemID) throws CMBException
itemID
- the persistent id of the itemCMBException
- public CMBProcessICM getProcess(java.lang.String processName) throws CMBException
processName
- the process nameCMBException
- public int getCount(java.lang.String worklistName, java.lang.String owner) throws CMBException
worklistName
- the name of the worklistowner
- the ownerCMBException
- public int getWorkPackagePriority(java.lang.String workpackagePID) throws CMBException
workpackagePID
- the work package pidCMBException
- public CMBWorkNodeICM getWorkNode(java.lang.String workNodeName) throws CMBException
workNodeName
- the name of the work node to be returned.CMBException
- public java.lang.String[] getWorkNodeNames() throws CMBException
CMBException
- public java.util.Collection getProcesses() throws CMBException
CMBException
- public java.util.Collection getWorkNodes() throws CMBException
CMBException
- public java.util.Collection getWorkLists() throws CMBException
CMBException
- public CMBWorkListICM getWorkList(java.lang.String worklistName) throws CMBException
worklistName
- the worklist nameCMBException
- public java.lang.String[] getWorkListNames() throws CMBException
CMBException
- public java.lang.String[] getProcessNames() throws CMBException
CMBException
- public java.lang.String getNextWorkPackagePidString(java.lang.String worklistName, java.lang.String owner) throws CMBException
worklistName
- the name of the worklistowner
- the ownerCMBException
- public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
onCMBConnectionReply
in interface CMBConnectionReplyListener
evt
- a CMBConnectionReplyEvent
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |