Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkWorkFlowMgmt

All Known Implementing Classes:
DKWorkFlowMgmtFed

public interface dkWorkFlowMgmt


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
 

Method Detail

adminOnly

public void adminOnly()
               throws DKException,
                      java.lang.Exception

getDatastore

public dkDatastore getDatastore()

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException,
                         java.lang.Exception

add

public void add(DKWorkFlowDiagramFed diagram)
         throws DKException,
                java.lang.Exception
Creates a new workflow diagram

update

public void update(DKWorkFlowDiagramFed diagram)
            throws DKException,
                   java.lang.Exception
Update a work flow diagram

retrieveWorkFlowDiagram

public DKWorkFlowDiagramFed retrieveWorkFlowDiagram(java.lang.String name)
                                             throws DKException,
                                                    java.lang.Exception
Retrieves a work flow diagram from persistent datastore
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

del

public void del(DKWorkFlowDiagramFed diagram)
         throws DKException,
                java.lang.Exception
Deletes a work flow action from the persistent datastore

getWorkFlowDiagram

public DKWorkFlowDiagramFed getWorkFlowDiagram(java.lang.String name)
                                        throws DKException,
                                               java.lang.Exception
Gets Work flow diagram from memory

listWorkFlowDiagramNames

public java.lang.String[] listWorkFlowDiagramNames()
                                            throws DKException,
                                                   java.lang.Exception
gets an array of workFlow diagram names

listWorkFlowDiagrams

public dkCollection listWorkFlowDiagrams()
                                  throws DKException,
                                         java.lang.Exception
gets a collection of workFlow diagrams

add

public void add(DKWorkFlowActionFed action)
         throws DKException,
                java.lang.Exception
Creates a new workflow action

update

public void update(DKWorkFlowActionFed action)
            throws DKException,
                   java.lang.Exception
Update a work flow action

retrieveWorkFlowAction

public DKWorkFlowActionFed retrieveWorkFlowAction(java.lang.String name)
                                           throws DKException,
                                                  java.lang.Exception
Retrieves a work flow action from persistent datastore
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

del

public void del(DKWorkFlowActionFed action)
         throws DKException,
                java.lang.Exception
Deletes a work flow action from the system

getWorkFlowAction

public DKWorkFlowActionFed getWorkFlowAction(java.lang.String name)
                                      throws DKException,
                                             java.lang.Exception
gets a DKWorkFlowActionFed object from a given action name

listWorkFlowActionNames

public java.lang.String[] listWorkFlowActionNames()
                                           throws DKException,
                                                  java.lang.Exception
gets an array of Action names

listWorkFlowActions

public dkCollection listWorkFlowActions()
                                 throws DKException,
                                        java.lang.Exception
gets a collection of DKWorkFlowActionFed objects

add

public void add(DKWorkFlowActionListFed actionList)
         throws DKException,
                java.lang.Exception
Creates a new workflow action list

update

public void update(DKWorkFlowActionListFed actionList)
            throws DKException,
                   java.lang.Exception
Update a work flow action list

retrieveWorkFlowActionList

public DKWorkFlowActionListFed retrieveWorkFlowActionList(java.lang.String name)
                                                   throws DKException,
                                                          java.lang.Exception
Retrieves a work flow action list from persistent datastore
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

del

public void del(DKWorkFlowActionListFed actionList)
         throws DKException,
                java.lang.Exception
Deletes a work flow action list from the system

getWorkFlowActionList

public DKWorkFlowActionListFed getWorkFlowActionList(java.lang.String name)
                                              throws DKException,
                                                     java.lang.Exception
Gets Action List from memory

listWorkFlowActionListNames

public java.lang.String[] listWorkFlowActionListNames()
                                               throws DKException,
                                                      java.lang.Exception
gets an array of Action List names

listWorkFlowActionLists

public dkCollection listWorkFlowActionLists()
                                     throws DKException,
                                            java.lang.Exception
gets a collection of DKWorkFlowActionListFed objects

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

add

public void add(DKWorkListAdminFed workList)
         throws DKException,
                java.lang.Exception
Creates a new DKWorkListAdminFed

update

public void update(DKWorkListAdminFed workList)
            throws DKException,
                   java.lang.Exception
Update a work list

retrieveWorkList

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

getWorkList

public DKWorkListAdminFed getWorkList(java.lang.String name)
                               throws DKException,
                                      java.lang.Exception
Gets Action List from memory

delWorkList

public void delWorkList(java.lang.String name)
                 throws DKException,
                        java.lang.Exception
Deletes a work list from the persistent datastore

del

public void del(DKWorkListAdminFed workList)
         throws DKException,
                java.lang.Exception
Deletes a work list from the system

getWorkListNames

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

listWorkLists

public dkCollection listWorkLists()
                           throws DKException,
                                  java.lang.Exception
gets a collection of DKWorkListAdminFed objects

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

getWorkPacket

public DKWorkPacketFed getWorkPacket(java.lang.String item_id)
                              throws DKException,
                                     java.lang.Exception
gets a DKWorkPacketFed object from a given work packet itemid

listWorkPacketNames

public java.lang.String[] listWorkPacketNames()
                                       throws DKException,
                                              java.lang.Exception
gets an array of Work Packet names

listWorkPackets

public dkCollection listWorkPackets()
                             throws DKException,
                                    java.lang.Exception
gets a collection of DKWorkPacketFed objects

add

public void add(DKWorkFlowEventFed event)
         throws DKException,
                java.lang.Exception
Creates a new work flow event

update

public void update(DKWorkFlowEventFed event)
            throws DKException,
                   java.lang.Exception
Update a work flow event

retrieveWorkFlowEvent

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

getWorkFlowEvent

public DKWorkFlowEventFed getWorkFlowEvent(java.lang.String activityName)
                                    throws DKException,
                                           java.lang.Exception
Gets Work Flow Event from memory

delWorkFlowEvent

public void delWorkFlowEvent(java.lang.String activityName)
                      throws DKException,
                             java.lang.Exception
Deletes a work flow event from the persistent datastore

del

public void del(DKWorkFlowEventFed event)
         throws DKException,
                java.lang.Exception
Deletes a work flow event from the system

listWorkFlowEventActivityNames

public java.lang.String[] listWorkFlowEventActivityNames()
                                                  throws DKException,
                                                         java.lang.Exception
gets an array of Work flow event activity names

listWorkFlowEvents

public dkCollection listWorkFlowEvents()
                                throws DKException,
                                       java.lang.Exception
gets a collection of DKWorkFlowEventFed objects

add

public void add(DKWorkFlowCollectionPointFed collectionPoint)
         throws DKException,
                java.lang.Exception
Creates a new work flow collection point object

update

public void update(DKWorkFlowCollectionPointFed collPoint)
            throws DKException,
                   java.lang.Exception
Update a work flow collection point

retrieveWorkFlowCollectionPoint

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

getWorkFlowCollectionPoint

public DKWorkFlowCollectionPointFed getWorkFlowCollectionPoint(java.lang.String processID)
                                                        throws DKException,
                                                               java.lang.Exception
Gets Collection Point from memory

delWorkFlowCollectionPoint

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

del

public void del(DKWorkFlowCollectionPointFed collectionPoint)
         throws DKException,
                java.lang.Exception
Deletes a work flow collection point from the system

listWorkFlowCollectionPointProcessIDs

public java.lang.String[] listWorkFlowCollectionPointProcessIDs()
                                                         throws DKException,
                                                                java.lang.Exception
gets an array of Work flow collection point processID

listWorkFlowCollectionPoints

public dkCollection listWorkFlowCollectionPoints()
                                          throws DKException,
                                                 java.lang.Exception
gets a collection of DKWorkFlowCollectionPointFed objects

setTraceEnabled

public void setTraceEnabled(boolean isEnabled)
Sets whether we should turn on trace for debuggin purpose
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
Returns:
true if trace is enabled, false otherwise

EIP Java APIs

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