Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkListAdminFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKWorkListAdminFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, dkWorkListAdmin, java.io.Serializable

public class DKWorkListAdminFed
extends java.lang.Object
implements dkWorkListAdmin, DKConstantFed, DKMessageIdFed, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKWorkListAdminFed()
          Default Constructor
DKWorkListAdminFed(dkDatastore ds)
          Constructor with dkDatastore reference
DKWorkListAdminFed(dkDatastore ds, java.lang.String name, java.lang.String aclName)
          Constructor with dkDatastore object reference
 
Method Summary
 void add()
          Adds this work list object into the persistent store
 void checkin()
          Deprecated.  
 void checkout()
          Deprecated.  
 void del()
          Deletes this work list from the persistent store
 java.lang.String getACLName()
          Gets the ACL name of this work list
 java.lang.String getCheckedOutUserid()
          Deprecated.  
 dkDatastore getDatastore()
          Gets the datastore
 long getID()
           
 java.lang.String getItemId()
          Gets the item_id of this work list
 java.lang.String getName()
          Gets the name of this work packet
 void retrieve()
          Retrieves this work packet from the persistent store
 void setACLName(java.lang.String aclName)
          Sets the ACL name of this work list
 void setDatastore(dkDatastore ds)
          Sets datastore object
 void setID(long id)
           
 void setItemId(java.lang.String item_id)
          Sets the item id of this work list
 void setName(java.lang.String name)
          Sets the name for this work list
 void unlockCheckedOut()
          Deprecated.  
 void update()
          Updates this work packet in the persistent store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkListAdminFed

public DKWorkListAdminFed()
Default Constructor

DKWorkListAdminFed

public DKWorkListAdminFed(dkDatastore ds)
Constructor with dkDatastore reference
Parameters:
ds - dkDatastore - datastore object

DKWorkListAdminFed

public DKWorkListAdminFed(dkDatastore ds,
                          java.lang.String name,
                          java.lang.String aclName)
Constructor with dkDatastore object reference
Parameters:
ds - datastore Object
name - work list name
aclName - ACL Name
Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the datastore
Specified by:
getDatastore in interface dkWorkListAdmin
Returns:
the datastore object associated with the work list object

setDatastore

public void setDatastore(dkDatastore ds)
Sets datastore object
Specified by:
setDatastore in interface dkWorkListAdmin
Parameters:
ds - the datastore object associated with this work list object

getName

public java.lang.String getName()
Gets the name of this work packet
Specified by:
getName in interface dkWorkListAdmin
Returns:
the name of the work packet object

setName

public void setName(java.lang.String name)
Sets the name for this work list
Specified by:
setName in interface dkWorkListAdmin
Parameters:
name - name of the work list object

setID

public void setID(long id)
Specified by:
setID in interface dkWorkListAdmin

getID

public long getID()
Specified by:
getID in interface dkWorkListAdmin

getACLName

public java.lang.String getACLName()
Gets the ACL name of this work list
Specified by:
getACLName in interface dkWorkListAdmin
Returns:
the ACL name of the work list object

setACLName

public void setACLName(java.lang.String aclName)
Sets the ACL name of this work list
Specified by:
setACLName in interface dkWorkListAdmin
Parameters:
aclName - the ACL name of the work list object

getItemId

public java.lang.String getItemId()
Gets the item_id of this work list
Specified by:
getItemId in interface dkWorkListAdmin
Returns:
the item_id of this work list

setItemId

public void setItemId(java.lang.String item_id)
Sets the item id of this work list
Specified by:
setItemId in interface dkWorkListAdmin
Parameters:
item_id - item id of the work list

add

public void add()
         throws DKAlreadyExistException,
                DKException
Adds this work list object into the persistent store
Specified by:
add in interface dkWorkListAdmin
Throws:
DKAlreadyExistException - if the work list already exists
DKException - when error occurs in the server

del

public void del()
         throws DKNotExistException,
                DKNotCheckedOutException,
                DKException
Deletes this work list from the persistent store
Specified by:
del in interface dkWorkListAdmin
Throws:
DKNotExitException - if the work list object does not exists
DKException - when error occurs in the server

update

public void update()
            throws DKNotExistException,
                   DKNotCheckedOutException,
                   DKException
Updates this work packet in the persistent store
Specified by:
update in interface dkWorkListAdmin
Throws:
DKNotExistException - if the work packet object does not exists
DKException - when error occurs in the server

retrieve

public void retrieve()
              throws DKNotExistException,
                     DKException
Retrieves this work packet from the persistent store
Specified by:
retrieve in interface dkWorkListAdmin
Throws:
DKNotExistException - if the work packet does not exists
DKException - when error occurs in the server

checkin

public void checkin()
             throws DKNotCheckedOutException,
                    DKException
Deprecated.  

Check in this work list to persistent datastore
Specified by:
checkin in interface dkWorkListAdmin
Throws:
DKNotCheckedOutException - if the work 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 DKNotExistException,
                     DKAlreadyCheckedOutException,
                     DKException
Deprecated.  

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

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException
Deprecated.  

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

getCheckedOutUserid

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

Gets the checked out userid of this work packet
Specified by:
getCheckedOutUserid in interface dkWorkListAdmin
Throws:
DKNotCheckedOutException - if the work packet 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.