Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkPersistentCheckableObject

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDataObjectBase
        |
        +--com.ibm.mm.sdk.common.dkDataObject
              |
              +--com.ibm.mm.sdk.common.dkPersistentObject
                    |
                    +--com.ibm.mm.sdk.common.dkPersistentCheckableObject
All Implemented Interfaces:
dkCheckableObject, DKConstant, dkDataObjectBase, DKMessageId, java.io.Serializable

public class dkPersistentCheckableObject
extends dkPersistentObject
implements dkCheckableObject, DKConstant, DKMessageId, java.io.Serializable

Interface for checkable objects

See Also:
Serialized Form

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.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkPersistentCheckableObject()
          Constructs a persistent object.
dkPersistentCheckableObject(dkDatastore ds)
          Constructs a persistent object with given a datastore.
dkPersistentCheckableObject(DKPid fromPid)
          Constructs a persistent object with given Pid.
 
Method Summary
 void checkin()
          checkin the object data
 void checkout()
          checkout the object data
 java.lang.String getCheckedOutUserid()
          get the checked out userid
 void unlockCheckedOut()
          unlocks currently checked out object data
 
Methods inherited from class com.ibm.mm.sdk.common.dkPersistentObject
add, del, getDatastore, getObjectType, protocol, retrieve, setDatastore, setObjectType, update
 
Methods inherited from class com.ibm.mm.sdk.common.dkDataObject
getPid, getPidObject, setPid, setPidObject
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase
getParent, getRootObject, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkPersistentCheckableObject

public dkPersistentCheckableObject()
Constructs a persistent object.

dkPersistentCheckableObject

public dkPersistentCheckableObject(DKPid fromPid)
Constructs a persistent object with given Pid.
Parameters:
fromPid - pid.

dkPersistentCheckableObject

public dkPersistentCheckableObject(dkDatastore ds)
Constructs a persistent object with given a datastore.
Parameters:
ds - datastore.
Method Detail

checkin

public void checkin()
             throws DKException
checkin the object data
Specified by:
checkin in interface dkCheckableObject

checkout

public void checkout()
              throws DKAlreadyCheckedOutException,
                     DKException
checkout the object data
Specified by:
checkout in interface dkCheckableObject

unlockCheckedOut

public void unlockCheckedOut()
                      throws DKNotCheckedOutException,
                             DKException
unlocks currently checked out object data
Specified by:
unlockCheckedOut in interface dkCheckableObject

getCheckedOutUserid

public java.lang.String getCheckedOutUserid()
                                     throws DKNotCheckedOutException,
                                            DKException
get the checked out userid
Specified by:
getCheckedOutUserid in interface dkCheckableObject

EIP Java APIs

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