Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkPersistentObject

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

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

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
dkPersistentObject()
          Constructs a persistent object.
dkPersistentObject(dkDatastore ds)
          Constructs a persistent object with given a datastore.
dkPersistentObject(DKPid fromPid)
          Constructs a persistent object with given Pid.
 
Method Summary
 void add()
          adds this action list into the persistent store
 void del()
          deletes this action list from the persistent store
 dkDatastore getDatastore()
          gets the datastore
 java.lang.String getObjectType()
          Gets the type of this data-object.
 short protocol()
          Returns the protocol type supported by this persistent-object.
 void retrieve()
          retrieves this action list from the persistent store
 void setDatastore(dkDatastore ds)
          sets datastore object
 void setObjectType(java.lang.String toObjectType)
          Sets the type of this data-object and synchronizes it with the object type of its Pid.
 void update()
          updates this action list in the persistent store
 
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

dkPersistentObject

public dkPersistentObject()
Constructs a persistent object.

dkPersistentObject

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

dkPersistentObject

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

getDatastore

public dkDatastore getDatastore()
gets the datastore

setDatastore

public void setDatastore(dkDatastore ds)
sets datastore object

add

public void add()
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds this action list into the persistent store

del

public void del()
         throws DKNotExistException,
                DKException,
                java.lang.Exception
deletes this action list from the persistent store

update

public void update()
            throws DKNotExistException,
                   DKException,
                   java.lang.Exception
updates this action list in the persistent store

retrieve

public void retrieve()
              throws DKNotExistException,
                     DKException,
                     java.lang.Exception
retrieves this action list from the persistent store

protocol

public short protocol()
Returns the protocol type supported by this persistent-object. In this case, it is DK_CM_PO,
Overrides:
protocol in class dkAbstractDataObjectBase
Returns:
the protocol.

getObjectType

public java.lang.String getObjectType()
Gets the type of this data-object.
Overrides:
getObjectType in class dkAbstractDataObjectBase
Returns:
the object type.

setObjectType

public void setObjectType(java.lang.String toObjectType)
Sets the type of this data-object and synchronizes it with the object type of its Pid.
Parameters:
toObjectType - the object type.

EIP Java APIs

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