Enterprise Information Portal APIs

com.ibm.mm.beans.workflow
Class CMBDocRoutingDataManagementICM

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

public class CMBDocRoutingDataManagementICM
extends java.lang.Object
implements java.io.Serializable, java.beans.PropertyChangeListener, CMBConnectionReplyListener

This bean provides services to manage ICM document routing data. You can obtain an instance of this bean from CMBConnection.

See Also:
CMBConnection, Serialized Form

Constructor Summary
CMBDocRoutingDataManagementICM()
          Default constructor.
 
Method Summary
 void addCMBExceptionListener(CMBExceptionListener alistener)
          CMBExceptionEvent registration method.
 void addCMBTraceListener(CMBTraceListener alistener)
          CMBTraceEvent registration method.
 boolean checkOutItemInWorkPackage(java.lang.String workpackagePID)
          Check out an item in a specified work package.
 java.lang.String continueProcess(java.lang.String workpackagePID, java.lang.String routeSelected, java.lang.String owner)
          Continue the work package to the next work node.
 CMBConnection getConnection()
          Returns the connection bean reference.
 boolean isTraceEnabled()
          Property getter.
 void onCMBConnectionReply(CMBConnectionReplyEvent evt)
          Implementation of connection reply service method.
 void propertyChange(java.beans.PropertyChangeEvent evt)
          On property change.
 void removeCMBExceptionListener(CMBExceptionListener alistener)
          CMBExceptionEvent unregistration method.
 void removeCMBTraceListener(CMBTraceListener alistener)
          CMBTraceEvent unregistration method.
 void resumeProcess(java.lang.String workpackagePID)
          Resume a process.
 void setConnection(CMBConnection conn)
          Set the reference of connection bean.
 void setTraceEnabled(boolean newValue)
          Sets the trace property value.
 void setWorkPackageOwner(java.lang.String workpackagePID, java.lang.String owner)
          Set the work package owner
 void setWorkPackagePriority(java.lang.String workpackagePID, int priority)
          Set the priority of the work package for the specified work package pid
 java.lang.String startProcess(java.lang.String processName, java.lang.String itemID, int priority, java.lang.String owner)
          Start a process.
 void suspendProcess(java.lang.String workpackagePID, int minutes, java.util.Collection resumeList)
          Suspend the process.
 void terminateProcess(java.lang.String workpackagePID)
          Terminate a process.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBDocRoutingDataManagementICM

public CMBDocRoutingDataManagementICM()
Default constructor.
Method Detail

continueProcess

public java.lang.String continueProcess(java.lang.String workpackagePID,
                                        java.lang.String routeSelected,
                                        java.lang.String owner)
                                 throws CMBException
Continue the work package to the next work node. The specified work package will be removed from the library server and a new work package is created for the specifed owner. The item referenced by the item PID will be checked in if it has been checked out. The PID of the new work package is returned unless the process has ended. If the process has ended then a null is returned.
Parameters:
workpackagePID - the work package pid
routeSelected - the route selected
owner - the owner
Returns:
the new workpackage pid , a null is returned if the process has ended
Throws:
CMBException -  

suspendProcess

public void suspendProcess(java.lang.String workpackagePID,
                           int minutes,
                           java.util.Collection resumeList)
                    throws CMBException
Suspend the process. The process with the specified work package is suspended for the specified minutes for the given resume list. The item referenced in the specified work package PID is checked in if the item is checked out. The suspend flag attribute of the the specified work package is set to true. The minutes define how long the suspend flag remains as true. The resume list is specified as a sequential collection of CMBResumeListEntryICM objects which consist of item type and quantity. The resume list only applies to a folder. The process waits for the arrival of the specified item type and quantities. If the suspension reaches the specified duration the suspension flag will be reset to false. If the resume list is satisfied the suspend flag will be reset to false.
Parameters:
workpackagePID - the work package pid
minutes - the number of minutes that the process will be suspended for
resumeList - a collection of CMBResumeListEntryICM objects.
Throws:
CMBException -  

setWorkPackagePriority

public void setWorkPackagePriority(java.lang.String workpackagePID,
                                   int priority)
                            throws CMBException
Set the priority of the work package for the specified work package pid
Parameters:
workpackagePID - the work package pid
Throws:
CMBException -  

setWorkPackageOwner

public void setWorkPackageOwner(java.lang.String workpackagePID,
                                java.lang.String owner)
                         throws CMBException
Set the work package owner
Parameters:
workpackagePID - the work package pid
owner - the owner
Throws:
CMBException -  

resumeProcess

public void resumeProcess(java.lang.String workpackagePID)
                   throws CMBException
Resume a process. The work package attribute, suspend flag, is set to false. No routing or checkout is performed on the work package.
Parameters:
workpackagePID - the pid of the work package to be resumed
Throws:
CMBException -  

startProcess

public java.lang.String startProcess(java.lang.String processName,
                                     java.lang.String itemID,
                                     int priority,
                                     java.lang.String owner)
                              throws CMBException
Start a process.
Parameters:
processName - the name of the process.
itemID - the pid of the item to be carried in the work package
priority - the priority of the work package.
owner - the owner. The owner is optional and may be an empty or null string. If the owner is an empty or null string, no user ID is assigned to the work package.
Returns:
the workpackage pid of the process started. The work package will be located at the first work node of the given process.
Throws:
CMBException -  

checkOutItemInWorkPackage

public boolean checkOutItemInWorkPackage(java.lang.String workpackagePID)
                                  throws CMBException
Check out an item in a specified work package.
Parameters:
workpackagePID - the work package pid
Returns:
true if the check out of the document or folder in the work package is successful, returns false otherwise
Throws:
CMBException -  

terminateProcess

public void terminateProcess(java.lang.String workpackagePID)
                      throws CMBException
Terminate a process. The work package specified will be removed from the system. The item referenced in the work package will be checked in if it is checked out.
Parameters:
workpackagePID - the work package pid of the process to be terminated
Throws:
CMBException -  

onCMBConnectionReply

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

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)
On property change.
Specified by:
propertyChange in interface java.beans.PropertyChangeListener
Parameters:
evt - a property changed event

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

isTraceEnabled

public boolean isTraceEnabled()
Property getter.
Returns:
isTraceEnabled property value

setTraceEnabled

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

setConnection

public void setConnection(CMBConnection conn)
Set the reference of connection bean.
Parameters:
conn - reference of connection bean

getConnection

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

EIP JavaBeans

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