Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowMgmtFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowMgmtFed
All Implemented Interfaces:
dkWorkFlowMgmt, java.io.Serializable

public class DKWorkFlowMgmtFed
extends java.lang.Object
implements dkWorkFlowMgmt, java.io.Serializable

See Also:
Serialized Form

Method Summary
 void add(DKWorkFlowActionFed action)
          Creates a new workflow action
 void add(DKWorkFlowActionListFed actionList)
          Creates a new workflow action list
 void add(DKWorkFlowCollectionPointFed collectionPoint)
          Creates a new work flow collection point object
 void add(DKWorkFlowDiagramFed diagram)
          Creates a new workflow diagram
 void add(DKWorkFlowEventFed event)
          Creates a new work flow event
 void add(DKWorkListAdminFed workList)
          Creates a new DKWorkListAdminFed
 void adminOnly()
           
 void del(DKWorkFlowActionFed action)
          Deletes a work flow action from the system
 void del(DKWorkFlowActionListFed actionList)
          Deletes a work flow action list from the system
 void del(DKWorkFlowCollectionPointFed collectionPoint)
          Deletes a work flow collection point from the system
 void del(DKWorkFlowDiagramFed diagram)
          Deletes a work flow action from the persistent datastore
 void del(DKWorkFlowEventFed event)
          Deletes a work flow event from the system
 void del(DKWorkListAdminFed workList)
          Deletes a work list from the system
 void delWorkFlowAction(java.lang.String name)
          Deletes a work flow action from the persistent datastore
 void delWorkFlowActionList(java.lang.String name)
          Deletes a work flow action list from the persistent datastore
 void delWorkFlowCollectionPoint(java.lang.String processID)
          Deletes a work flow collection point from the persistent datastore
 void delWorkFlowDiagram(java.lang.String name)
          Deletes a work flow diagram from the persistent datastore
 void delWorkFlowEvent(java.lang.String activityName)
          Deletes a work flow event from the persistent datastore
 void delWorkList(java.lang.String name)
          Deletes a work list from the persistent datastore
 dkDatastore getDatastore()
           
 DKWorkFlowActionFed getWorkFlowAction(java.lang.String name)
          gets a DKWorkFlowActionFed object from a given action name
 DKWorkFlowActionListFed getWorkFlowActionList(java.lang.String name)
          Gets Action List from memory
 DKWorkFlowCollectionPointFed getWorkFlowCollectionPoint(java.lang.String processID)
          Gets Collection Point from memory
 DKWorkFlowDiagramFed getWorkFlowDiagram(java.lang.String name)
          Gets Work flow diagram from memory
 DKWorkFlowEventFed getWorkFlowEvent(java.lang.String activityName)
          Gets Work Flow Event from memory
 DKWorkListAdminFed getWorkList(java.lang.String name)
          Gets Action List from memory
 java.lang.String[] getWorkListNames()
          gets an array of Work List names for the currently logon user
 java.lang.String[] getWorkListNames(java.lang.String userid)
          gets an array of Work List names for the given userid
 DKWorkPacketFed getWorkPacket(java.lang.String item_id)
          gets a DKWorkPacketFed object from a given work packet itemid
 boolean isTraceEnabled()
          Checks to see if trace is currently enabled
 java.lang.String[] listWorkFlowActionListNames()
          gets an array of Action List names
 dkCollection listWorkFlowActionLists()
          gets a collection of DKWorkFlowActionListFed objects
 java.lang.String[] listWorkFlowActionNames()
          gets an array of Action names
 java.lang.String[] listWorkFlowActionNames(java.lang.String name)
          gets an array of action names for a particular action list
 dkCollection listWorkFlowActions()
          gets a collection of DKWorkFlowActionFed objects
 java.lang.String[] listWorkFlowCollectionPointProcessIDs()
          gets an array of Work flow collection point processID
 dkCollection listWorkFlowCollectionPoints()
          gets a collection of DKWorkFlowCollectionPointFed objects
 java.lang.String[] listWorkFlowDiagramNames()
          gets an array of workFlow diagram names
 dkCollection listWorkFlowDiagrams()
          gets a collection of workFlow diagrams
 java.lang.String[] listWorkFlowEventActivityNames()
          gets an array of Work flow event activity names
 dkCollection listWorkFlowEvents()
          gets a collection of DKWorkFlowEventFed objects
 dkCollection listWorkLists()
          gets a collection of DKWorkListAdminFed objects
 java.lang.String[] listWorkPacketNames()
          gets an array of Work Packet names
 dkCollection listWorkPackets()
          gets a collection of DKWorkPacketFed objects
 DKWorkFlowActionFed retrieveWorkFlowAction(java.lang.String name)
          Retrieves a work flow action from persistent datastore
 DKWorkFlowActionListFed retrieveWorkFlowActionList(java.lang.String name)
          Retrieves a work flow action list from persistent datastore
 DKWorkFlowCollectionPointFed retrieveWorkFlowCollectionPoint(java.lang.String processID)
          Retrieves a work flow collection point from persistent datastore
 DKWorkFlowDiagramFed retrieveWorkFlowDiagram(java.lang.String name)
          Retrieves a work flow diagram from persistent datastore
 DKWorkFlowEventFed retrieveWorkFlowEvent(java.lang.String name)
          Retrieves a work flow event from persistent datastore
 DKWorkListAdminFed retrieveWorkList(java.lang.String name)
          Retrieves a work list from persistent datastore
 void setDatastore(dkDatastore ds)
           
 void setTraceEnabled(boolean isEnabled)
          Sets whether we should turn on trace for debuggin purpose
 void update(DKWorkFlowActionFed action)
          Update a work flow action
 void update(DKWorkFlowActionListFed actionList)
          Update a work flow action list
 void update(DKWorkFlowCollectionPointFed collPoint)
          Update a work flow collection point
 void update(DKWorkFlowDiagramFed diagram)
          Update a work flow diagram
 void update(DKWorkFlowEventFed event)
          Update a work flow event
 void update(DKWorkListAdminFed workList)
          Update a work list
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

adminOnly

public void adminOnly()
               throws DKException,
                      java.lang.Exception
Specified by:
adminOnly in interface dkWorkFlowMgmt

getDatastore

public dkDatastore getDatastore()
Specified by:
getDatastore in interface dkWorkFlowMgmt

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException,
                         java.lang.Exception
Specified by:
setDatastore in interface dkWorkFlowMgmt

add

public void add(DKWorkFlowDiagramFed diagram)
         throws DKException,
                java.lang.Exception
Creates a new workflow diagram
Specified by:
add in interface dkWorkFlowMgmt

update

public void update(DKWorkFlowDiagramFed diagram)
            throws DKException,
                   java.lang.Exception
Update a work flow diagram
Specified by:
update in interface dkWorkFlowMgmt

retrieveWorkFlowDiagram

public DKWorkFlowDiagramFed retrieveWorkFlowDiagram(java.lang.String name)
                                             throws DKException,
                                                    java.lang.Exception
Retrieves a work flow diagram from persistent datastore
Specified by:
retrieveWorkFlowDiagram in interface dkWorkFlowMgmt
Returns:
work flow diagram

delWorkFlowDiagram

public void delWorkFlowDiagram(java.lang.String name)
                        throws DKException,
                               java.lang.Exception
Deletes a work flow diagram from the persistent datastore
Specified by:
delWorkFlowDiagram in interface dkWorkFlowMgmt

del

public void del(DKWorkFlowDiagramFed diagram)
         throws DKException,
                java.lang.Exception
Deletes a work flow action from the persistent datastore
Specified by:
del in interface dkWorkFlowMgmt

getWorkFlowDiagram

public DKWorkFlowDiagramFed getWorkFlowDiagram(java.lang.String name)
                                        throws DKException,
                                               java.lang.Exception
Gets Work flow diagram from memory
Specified by:
getWorkFlowDiagram in interface dkWorkFlowMgmt

listWorkFlowDiagramNames

public java.lang.String[] listWorkFlowDiagramNames()
                                            throws DKException,
                                                   java.lang.Exception
gets an array of workFlow diagram names
Specified by:
listWorkFlowDiagramNames in interface dkWorkFlowMgmt

listWorkFlowDiagrams

public dkCollection listWorkFlowDiagrams()
                                  throws DKException,
                                         java.lang.Exception
gets a collection of workFlow diagrams
Specified by:
listWorkFlowDiagrams in interface dkWorkFlowMgmt

add

public void add(DKWorkFlowActionFed action)
         throws DKException,
                java.lang.Exception
Creates a new workflow action
Specified by:
add in interface dkWorkFlowMgmt

update

public void update(DKWorkFlowActionFed action)
            throws DKException,
                   java.lang.Exception
Update a work flow action
Specified by:
update in interface dkWorkFlowMgmt

retrieveWorkFlowAction

public DKWorkFlowActionFed retrieveWorkFlowAction(java.lang.String name)
                                           throws DKException,
                                                  java.lang.Exception
Retrieves a work flow action from persistent datastore
Specified by:
retrieveWorkFlowAction in interface dkWorkFlowMgmt
Returns:
work flow action

delWorkFlowAction

public void delWorkFlowAction(java.lang.String name)
                       throws DKException,
                              java.lang.Exception
Deletes a work flow action from the persistent datastore
Specified by:
delWorkFlowAction in interface dkWorkFlowMgmt

del

public void del(DKWorkFlowActionFed action)
         throws DKException,
                java.lang.Exception
Deletes a work flow action from the system
Specified by:
del in interface dkWorkFlowMgmt

getWorkFlowAction

public DKWorkFlowActionFed getWorkFlowAction(java.lang.String name)
                                      throws DKException,
                                             java.lang.Exception
gets a DKWorkFlowActionFed object from a given action name
Specified by:
getWorkFlowAction in interface dkWorkFlowMgmt

listWorkFlowActionNames

public java.lang.String[] listWorkFlowActionNames()
                                           throws DKException,
                                                  java.lang.Exception
gets an array of Action names
Specified by:
listWorkFlowActionNames in interface dkWorkFlowMgmt

listWorkFlowActions

public dkCollection listWorkFlowActions()
                                 throws DKException,
                                        java.lang.Exception
gets a collection of DKWorkFlowActionFed objects
Specified by:
listWorkFlowActions in interface dkWorkFlowMgmt

add

public void add(DKWorkFlowActionListFed actionList)
         throws DKException,
                java.lang.Exception
Creates a new workflow action list
Specified by:
add in interface dkWorkFlowMgmt

update

public void update(DKWorkFlowActionListFed actionList)
            throws DKException,
                   java.lang.Exception
Update a work flow action list
Specified by:
update in interface dkWorkFlowMgmt

retrieveWorkFlowActionList

public DKWorkFlowActionListFed retrieveWorkFlowActionList(java.lang.String name)
                                                   throws DKException,
                                                          java.lang.Exception
Retrieves a work flow action list from persistent datastore
Specified by:
retrieveWorkFlowActionList in interface dkWorkFlowMgmt
Returns:
work flow action list

delWorkFlowActionList

public void delWorkFlowActionList(java.lang.String name)
                           throws DKException,
                                  java.lang.Exception
Deletes a work flow action list from the persistent datastore
Specified by:
delWorkFlowActionList in interface dkWorkFlowMgmt

del

public void del(DKWorkFlowActionListFed actionList)
         throws DKException,
                java.lang.Exception
Deletes a work flow action list from the system
Specified by:
del in interface dkWorkFlowMgmt

getWorkFlowActionList

public DKWorkFlowActionListFed getWorkFlowActionList(java.lang.String name)
                                              throws DKException,
                                                     java.lang.Exception
Gets Action List from memory
Specified by:
getWorkFlowActionList in interface dkWorkFlowMgmt

listWorkFlowActionListNames

public java.lang.String[] listWorkFlowActionListNames()
                                               throws DKException,
                                                      java.lang.Exception
gets an array of Action List names
Specified by:
listWorkFlowActionListNames in interface dkWorkFlowMgmt

listWorkFlowActionLists

public dkCollection listWorkFlowActionLists()
                                     throws DKException,
                                            java.lang.Exception
gets a collection of DKWorkFlowActionListFed objects
Specified by:
listWorkFlowActionLists in interface dkWorkFlowMgmt

listWorkFlowActionNames

public java.lang.String[] listWorkFlowActionNames(java.lang.String name)
                                           throws DKException,
                                                  java.lang.Exception
gets an array of action names for a particular action list
Specified by:
listWorkFlowActionNames in interface dkWorkFlowMgmt

add

public void add(DKWorkListAdminFed workList)
         throws DKException,
                java.lang.Exception
Creates a new DKWorkListAdminFed
Specified by:
add in interface dkWorkFlowMgmt

update

public void update(DKWorkListAdminFed workList)
            throws DKException,
                   java.lang.Exception
Update a work list
Specified by:
update in interface dkWorkFlowMgmt

retrieveWorkList

public DKWorkListAdminFed retrieveWorkList(java.lang.String name)
                                    throws DKException,
                                           java.lang.Exception
Retrieves a work list from persistent datastore
Specified by:
retrieveWorkList in interface dkWorkFlowMgmt
Returns:
a work list

getWorkList

public DKWorkListAdminFed getWorkList(java.lang.String name)
                               throws DKException,
                                      java.lang.Exception
Gets Action List from memory
Specified by:
getWorkList in interface dkWorkFlowMgmt

delWorkList

public void delWorkList(java.lang.String name)
                 throws DKException,
                        java.lang.Exception
Deletes a work list from the persistent datastore
Specified by:
delWorkList in interface dkWorkFlowMgmt

del

public void del(DKWorkListAdminFed workList)
         throws DKException,
                java.lang.Exception
Deletes a work list from the system
Specified by:
del in interface dkWorkFlowMgmt

getWorkListNames

public java.lang.String[] getWorkListNames()
                                    throws DKException,
                                           java.lang.Exception
gets an array of Work List names for the currently logon user
Specified by:
getWorkListNames in interface dkWorkFlowMgmt

listWorkLists

public dkCollection listWorkLists()
                           throws DKException,
                                  java.lang.Exception
gets a collection of DKWorkListAdminFed objects
Specified by:
listWorkLists in interface dkWorkFlowMgmt

getWorkListNames

public java.lang.String[] getWorkListNames(java.lang.String userid)
                                    throws DKException,
                                           java.lang.Exception
gets an array of Work List names for the given userid
Specified by:
getWorkListNames in interface dkWorkFlowMgmt

getWorkPacket

public DKWorkPacketFed getWorkPacket(java.lang.String item_id)
                              throws DKException,
                                     java.lang.Exception
gets a DKWorkPacketFed object from a given work packet itemid
Specified by:
getWorkPacket in interface dkWorkFlowMgmt

listWorkPacketNames

public java.lang.String[] listWorkPacketNames()
                                       throws DKException,
                                              java.lang.Exception
gets an array of Work Packet names
Specified by:
listWorkPacketNames in interface dkWorkFlowMgmt

listWorkPackets

public dkCollection listWorkPackets()
                             throws DKException,
                                    java.lang.Exception
gets a collection of DKWorkPacketFed objects
Specified by:
listWorkPackets in interface dkWorkFlowMgmt

add

public void add(DKWorkFlowEventFed event)
         throws DKException,
                java.lang.Exception
Creates a new work flow event
Specified by:
add in interface dkWorkFlowMgmt

update

public void update(DKWorkFlowEventFed event)
            throws DKException,
                   java.lang.Exception
Update a work flow event
Specified by:
update in interface dkWorkFlowMgmt

retrieveWorkFlowEvent

public DKWorkFlowEventFed retrieveWorkFlowEvent(java.lang.String name)
                                         throws DKException,
                                                java.lang.Exception
Retrieves a work flow event from persistent datastore
Specified by:
retrieveWorkFlowEvent in interface dkWorkFlowMgmt
Returns:
work flow event

getWorkFlowEvent

public DKWorkFlowEventFed getWorkFlowEvent(java.lang.String activityName)
                                    throws DKException,
                                           java.lang.Exception
Gets Work Flow Event from memory
Specified by:
getWorkFlowEvent in interface dkWorkFlowMgmt

delWorkFlowEvent

public void delWorkFlowEvent(java.lang.String activityName)
                      throws DKException,
                             java.lang.Exception
Deletes a work flow event from the persistent datastore
Specified by:
delWorkFlowEvent in interface dkWorkFlowMgmt

del

public void del(DKWorkFlowEventFed event)
         throws DKException,
                java.lang.Exception
Deletes a work flow event from the system
Specified by:
del in interface dkWorkFlowMgmt

listWorkFlowEventActivityNames

public java.lang.String[] listWorkFlowEventActivityNames()
                                                  throws DKException,
                                                         java.lang.Exception
gets an array of Work flow event activity names
Specified by:
listWorkFlowEventActivityNames in interface dkWorkFlowMgmt

listWorkFlowEvents

public dkCollection listWorkFlowEvents()
                                throws DKException,
                                       java.lang.Exception
gets a collection of DKWorkFlowEventFed objects
Specified by:
listWorkFlowEvents in interface dkWorkFlowMgmt

add

public void add(DKWorkFlowCollectionPointFed collectionPoint)
         throws DKException,
                java.lang.Exception
Creates a new work flow collection point object
Specified by:
add in interface dkWorkFlowMgmt

update

public void update(DKWorkFlowCollectionPointFed collPoint)
            throws DKException,
                   java.lang.Exception
Update a work flow collection point
Specified by:
update in interface dkWorkFlowMgmt

retrieveWorkFlowCollectionPoint

public DKWorkFlowCollectionPointFed retrieveWorkFlowCollectionPoint(java.lang.String processID)
                                                             throws DKException,
                                                                    java.lang.Exception
Retrieves a work flow collection point from persistent datastore
Specified by:
retrieveWorkFlowCollectionPoint in interface dkWorkFlowMgmt
Returns:
work flow collection point

getWorkFlowCollectionPoint

public DKWorkFlowCollectionPointFed getWorkFlowCollectionPoint(java.lang.String processID)
                                                        throws DKException,
                                                               java.lang.Exception
Gets Collection Point from memory
Specified by:
getWorkFlowCollectionPoint in interface dkWorkFlowMgmt

delWorkFlowCollectionPoint

public void delWorkFlowCollectionPoint(java.lang.String processID)
                                throws DKException,
                                       java.lang.Exception
Deletes a work flow collection point from the persistent datastore
Specified by:
delWorkFlowCollectionPoint in interface dkWorkFlowMgmt

del

public void del(DKWorkFlowCollectionPointFed collectionPoint)
         throws DKException,
                java.lang.Exception
Deletes a work flow collection point from the system
Specified by:
del in interface dkWorkFlowMgmt

listWorkFlowCollectionPointProcessIDs

public java.lang.String[] listWorkFlowCollectionPointProcessIDs()
                                                         throws DKException,
                                                                java.lang.Exception
gets an array of Work flow collection point processID
Specified by:
listWorkFlowCollectionPointProcessIDs in interface dkWorkFlowMgmt

listWorkFlowCollectionPoints

public dkCollection listWorkFlowCollectionPoints()
                                          throws DKException,
                                                 java.lang.Exception
gets a collection of DKWorkFlowCollectionPointFed objects
Specified by:
listWorkFlowCollectionPoints in interface dkWorkFlowMgmt

setTraceEnabled

public void setTraceEnabled(boolean isEnabled)
Sets whether we should turn on trace for debuggin purpose
Specified by:
setTraceEnabled in interface dkWorkFlowMgmt
Parameters:
isEnabled - true if want to turn on trace, false otherwise, default is no trace

isTraceEnabled

public boolean isTraceEnabled()
Checks to see if trace is currently enabled
Specified by:
isTraceEnabled in interface dkWorkFlowMgmt
Returns:
true if trace is enabled, false otherwise

EIP Java APIs

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