Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkFlowActionListFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkFlowActionListFed
All Implemented Interfaces:
dkCheckableObject, dkWorkFlowActionList, java.io.Serializable

public class DKWorkFlowActionListFed
extends java.lang.Object
implements dkWorkFlowActionList, java.io.Serializable

This class represents an action list object.

See Also:
Serialized Form

Constructor Summary
DKWorkFlowActionListFed()
          Default Constructor
DKWorkFlowActionListFed(dkDatastore ds)
          Constructs a work flow action list object with datastore reference
DKWorkFlowActionListFed(dkDatastore ds, java.lang.String name, java.lang.String description)
          Constructs a work flow action list object for Fed
 
Method Summary
 void add()
          Deprecated.  
 void addWorkFlowAction(dkWorkFlowAction actionObj)
          Adds a new work flow action object to this work flow action list, memory only
 void checkin()
          Deprecated.  
 void checkout()
          Deprecated.  
 void del()
          Deprecated.  
 java.lang.String getCheckedOutUserid()
          Deprecated.  
 dkDatastore getDatastore()
          Gets the datastore
 java.lang.String getDescription()
          Gets the description of this work flow action list
 java.lang.String getItemId()
          Deprecated.  
 java.lang.String getName()
          Gets the name of this work flow action list
 dkCollection getWorkFlowActions()
          Deprecated.  
 boolean isRetrieved()
           
 java.lang.String[] listWorkFlowActionNames()
          Gets a list of action names from persistent datastore
 dkCollection listWorkFlowActions()
          Gets a list of actions in this action list
 void removeAllWorkFlowActions()
          Remove all work flow actions from this work flow action list, memory only
 void removeWorkFlowAction(java.lang.String name)
          Remove an action from this action list, memory only
 void retrieve()
          Deprecated.  
 void setDatastore(dkDatastore ds)
          Sets the datastore object
 void setDescription(java.lang.String description)
          Sets the description of this work flow action list
 void setItemId(java.lang.String id)
          Deprecated.  
 void setName(java.lang.String name)
          sets the name for this work flow action list
 void setRetrieved(boolean isRetrieved)
           
 void setWorkFlowActions(dkCollection actionColl)
          Sets the collecction of dkWorkFlowAction objects to this action list, memory only
 void unlockCheckedOut()
          Deprecated.  
 void update()
          Deprecated.  
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkFlowActionListFed

public DKWorkFlowActionListFed()
Default Constructor

DKWorkFlowActionListFed

public DKWorkFlowActionListFed(dkDatastore ds)
Constructs a work flow action list object with datastore reference
Parameters:
ds - Datastore object
Throws:
DKException - if the ds is null

DKWorkFlowActionListFed

public DKWorkFlowActionListFed(dkDatastore ds,
                               java.lang.String name,
                               java.lang.String description)
Constructs a work flow action list object for Fed
Parameters:
ds - dkDatastore
name - name of the work flow action list
description - description of the work flow action list
Throws:
DKException - if the ds is null
Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the datastore
Returns:
dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
Sets the datastore object
Parameters:
ds - dkDatastore - datastore object

isRetrieved

public boolean isRetrieved()

setRetrieved

public void setRetrieved(boolean isRetrieved)

getItemId

public java.lang.String getItemId()
Deprecated.  

Gets the unique item id for this work flow action list object
Returns:
the id of the work packet object

setItemId

public void setItemId(java.lang.String id)
Deprecated.  

Sets the unique item id for this work packet
Parameters:
id - item id of the work flow action list object

getName

public java.lang.String getName()
Gets the name of this work flow action list
Returns:
the name of this work flow action list

setName

public void setName(java.lang.String name)
sets the name for this work flow action list
Parameters:
name - name of this work flow action list

getDescription

public java.lang.String getDescription()
Gets the description of this work flow action list
Returns:
the description of this work flow action list

setDescription

public void setDescription(java.lang.String description)
Sets the description of this work flow action list
Parameters:
description - description of this work flow action list

add

public void add()
         throws DKAlreadyExistException,
                DKException
Deprecated.  

Adds this work flow action list into the persistent store
Throws:
DKAlreadyExistException - if the work flow action already exists
DKException - when error occurs in the server

del

public void del()
         throws DKNotExistException,
                DKNotCheckedOutException,
                DKException
Deprecated.  

Deletes this action list from the persistent store
Throws:
DKNotExitException - if the work flow action list object does not exists
DKException - when error occurs in the server

update

public void update()
            throws DKNotExistException,
                   DKNotCheckedOutException,
                   DKException
Deprecated.  

Update this work flow action list in the persistent store
Throws:
DKNotExistException - if the work flow action list object does not exists
DKException - when error occurs in the server

retrieve

public void retrieve()
              throws DKNotExistException,
                     DKException
Deprecated.  

Retrieves this work flow action list from the persistent store
Throws:
DKNotExistException - if the work flow action list does not exists
DKException - when error occurs in the server

listWorkFlowActions

public dkCollection listWorkFlowActions()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of actions in this action list
Returns:
a collection of action objects
Throws:
DKException - when error occurs in the server

listWorkFlowActionNames

public java.lang.String[] listWorkFlowActionNames()
                                           throws DKException,
                                                  java.lang.Exception
Gets a list of action names from persistent datastore
Specified by:
listWorkFlowActionNames in interface dkWorkFlowActionList
Returns:
an array of action names
Throws:
DKException - if error occurs

getWorkFlowActions

public dkCollection getWorkFlowActions()
                                throws DKException,
                                       java.lang.Exception
Deprecated.  

Gets the collection of dkWorkFlowAction objects in this action list, memory only
Specified by:
getWorkFlowActions in interface dkWorkFlowActionList
Throws:
DKException - when error occurs in the server

setWorkFlowActions

public void setWorkFlowActions(dkCollection actionColl)
                        throws DKException
Sets the collecction of dkWorkFlowAction objects to this action list, memory only
Specified by:
setWorkFlowActions in interface dkWorkFlowActionList
Throws:
DKException - when error occurs in the server

addWorkFlowAction

public void addWorkFlowAction(dkWorkFlowAction actionObj)
                       throws DKException
Adds a new work flow action object to this work flow action list, memory only
Specified by:
addWorkFlowAction in interface dkWorkFlowActionList
Parameters:
actionObj - the new work flow action to be added
Throws:
DKException - when error occurs in the server

removeWorkFlowAction

public void removeWorkFlowAction(java.lang.String name)
                          throws DKException
Remove an action from this action list, memory only
Specified by:
removeWorkFlowAction in interface dkWorkFlowActionList
Parameters:
name - the name of the work flow action object to be removed
Throws:
DKException - when error occurs in the server

removeAllWorkFlowActions

public void removeAllWorkFlowActions()
                              throws DKException
Remove all work flow actions from this work flow action list, memory only
Specified by:
removeAllWorkFlowActions in interface dkWorkFlowActionList
Throws:
DKException - when error occurs in the server

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException
Deprecated.  

Checkin this work flow action list to persistent datastore
Specified by:
checkin in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow action list is not checked out by the current user or been checked out by a different user
DKException - when error occurs in the server

checkout

public void checkout()
              throws DKAlreadyCheckedOutException,
                     DKException
Deprecated.  

Check out this work flow action list from persistent datastore
Specified by:
checkout in interface dkCheckableObject
Throws:
DKAlreadyCheckedOutException - if the work flow action list has already been checked out
DKException - when error occurs in the server

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException
Deprecated.  

Unlocks this work flow action list, which is currently checked out, from persistent datastore
Specified by:
unlockCheckedOut in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow action list is not checked out
DKException - when error occurs in the server

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException
Deprecated.  

Get the checked out userid of this work flow action list
Specified by:
getCheckedOutUserid in interface dkCheckableObject
Throws:
DKNotCheckedOutException - if the work flow action list is not checked out
DKException - when error occurs in the server

EIP Java APIs

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