Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkWorkListAdmin

All Known Implementing Classes:
DKWorkListAdminFed

public interface dkWorkListAdmin


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
 

Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the datastore
Returns:
the datastore object associated with the work list object

setDatastore

public void setDatastore(dkDatastore ds)
Sets datastore object
Parameters:
ds - the datastore object associated with this work list object

getName

public java.lang.String getName()
Gets the name of this work packet
Returns:
the name of the work packet object

setName

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

setID

public void setID(long id)

getID

public long getID()

getACLName

public java.lang.String getACLName()
Gets the ACL name of this work list
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
Parameters:
aclName - the ACL name of the work list object

getItemId

public java.lang.String getItemId()
Gets the item_id of this work list
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
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
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
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
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
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
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
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
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
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.