|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractDataObjectBase | +--com.ibm.mm.sdk.common.dkDataObject | +--com.ibm.mm.sdk.common.DKDDOBase | +--com.ibm.mm.sdk.common.DKDDO
DKDDO is the class to represents a Dynamic Data Object (DDO). It is a sub-class of DKDDOBase with additional methods to support persistency, such as add(), retrieve(), update(), and del(). Its purpose is for representing data-objects and to transfer tehm to and from the persistent store. See DKDDOBase for more information.
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 | |
DKDDO()
Constructs a DDO object. |
|
DKDDO(dkDatastore ds,
DKPid pid)
Constructs a DDO object with a given PID and the datastore associated with it. |
|
DKDDO(dkDatastore ds,
DKPid pid,
short initialSize)
Constructs a DDO object with a given PID, the datastore associated with it, and an initial number of data-items. |
|
DKDDO(dkDatastore ds,
java.lang.String objectType)
Constructs a DDO object for a given object type in the specified datastore. |
|
DKDDO(dkDatastore ds,
java.lang.String objectType,
short initialSize)
Constructs a DDO object for a given object type, with an initial number of data-items and the datastore associated with it. |
|
DKDDO(DKDDO ddo)
Constructs a DDO object by copying another DDO object (copy constructor). |
|
DKDDO(DKPid pid)
Constructs a DDO object with a given PID. |
|
DKDDO(DKPid pid,
short initialSize)
Constructs a DDO object with a given PID and an initial number of data-items. |
|
DKDDO(short initialSize)
Constructs a DDO object which has enough space for the given initial number of data-items. |
|
DKDDO(java.lang.String objectType)
Constructs a DDO object for a given object type. |
|
DKDDO(java.lang.String objectType,
short initialSize)
Constructs a DDO object for a given object type, with an initial number of data-items. |
Method Summary | |
void |
add()
Adds this data-object to the persistent store. |
void |
add(DKNVPair[] options)
Adds this data-object to the persistent store with options. |
void |
add(int option)
Adds this data-object to the persistent store with option. |
void |
del()
Deletes this object from the persistent store. |
void |
del(DKNVPair[] options)
Deletes this object from the persistent store with options. |
void |
del(int option)
Deletes this object from the persistent store with option. |
static dkDataObjectBase |
fromXML(DKNVPair xmlSource)
Creates a new DKDDO object using the given XML input source. |
static dkDataObjectBase |
fromXML(DKNVPair xmlSource,
int options)
Creates a new DKDDO object using the given XML input source. |
dkDatastore |
getDatastore()
Gets the associated datastore for this DDO. |
short |
protocol()
Returns the protocol type supported by this data-object. |
void |
retrieve()
Retrieve this data-object from the persistent store. |
void |
retrieve(DKNVPair[] options)
Retrieve this data-object from the persistent store with options. |
void |
retrieve(int option)
Retrieve this data-object from the persistent store with option. |
void |
setDatastore(dkDatastore ds)
Sets this datastore as the one associated with this DDO; that is, the datastore to keep the persistent copy of this DDO. |
void |
toXML(DKNVPair xmlDestination,
java.lang.String path,
int options)
Generates the corresponding XML from this DKDDO. |
void |
update()
Updates this object in the persistent store. |
void |
update(DKNVPair[] options)
Updates this object in the persistent store with options. |
void |
update(int option)
Updates this object in the persistent store with option. |
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 |
public DKDDO()
public DKDDO(short initialSize)
initialSize
- the initial number of data-items.public DKDDO(DKDDO ddo)
ddo
- the other existing DDO object.public DKDDO(java.lang.String objectType)
objectType
- an object-type. The object type
which usually corresponds to an entity name.public DKDDO(java.lang.String objectType, short initialSize)
objectType
- an object-type.initialSize
- the initial number of data items.public DKDDO(dkDatastore ds, java.lang.String objectType)
ds
- a datastore object.objectType
- an object-type.public DKDDO(dkDatastore ds, java.lang.String objectType, short initialSize)
ds
- a datastore object.objectType
- an object-type.initialSize
- the initial number of data-items.public DKDDO(DKPid pid)
pid
- a PID object.public DKDDO(DKPid pid, short initialSize)
pid
- a PID object.initialSize
- the initial number of data-items.public DKDDO(dkDatastore ds, DKPid pid)
ds
- a datastore object.pid
- a PID object.public DKDDO(dkDatastore ds, DKPid pid, short initialSize)
ds
- a datastore object.pid
- a PID object.initialSize
- the initial number of data-items.Method Detail |
public static dkDataObjectBase fromXML(DKNVPair xmlSource, int options) throws DKException, java.lang.Exception
xmlSource
- a DKNVPair object specifyng the XML source characteristics,
with the following possible values:
options
- options for XML processing
DKException
- if a problem is encountered.public static dkDataObjectBase fromXML(DKNVPair xmlSource) throws DKException, java.lang.Exception
xmlSource
- a DKNVPair object specifyng the XML source characteristics,
with the following possible values:
DKException
- if a problem is encountered.public void toXML(DKNVPair xmlDestination, java.lang.String path, int options) throws DKException, java.lang.Exception
xmlDestination
- specifies where the XML output should go,
valid values are:
path
- indicates the file directory of the ddo.dtdoptions
- options for XML processing
DKException
- if a problem is encountered.public void setDatastore(dkDatastore ds)
ds
- a datastore object.public dkDatastore getDatastore()
public short protocol()
protocol
in class DKDDOBase
public void add() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void add(int option) throws DKException, java.lang.Exception
option
- option for add. It is a combination of flag
settings to pass additional information, such as checkout
after creation. See valid option values under the specific
datastore class documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void add(DKNVPair[] options) throws DKException, java.lang.Exception
options
- options for add. Currently this option is not enabled.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void retrieve() throws DKException, java.lang.Exception
DKException
- if a problem is encountered.public void retrieve(int option) throws DKException, java.lang.Exception
option
- option for retrieve. It is a combination of flag
settings to tailor the granularity of the retrieval. See valid option
values under the specific datastore class documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void retrieve(DKNVPair[] options) throws DKException, java.lang.Exception
options
- options for retrieve. The option is in the form
of name-value pairs, to allow a more flexible way of passing
information such as projection list and version number.
See vaild option values under the specific datastore class
documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void update() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void update(int option) throws DKException, java.lang.Exception
option
- option for update. It is a combination of flag
settings to pass additional information, such as creating a new
version instead of update in place. See valid option values
under the specific datastore class documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void update(DKNVPair[] options) throws DKException, java.lang.Exception
options
- options for update. The option is in the form of
name-value pairs, to allow a more flexible way of passing information
such as version number to update. See valid option values under
the specific datastore class documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void del() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void del(int option) throws DKException, java.lang.Exception
option
- option for delete. It is a combination of flag settings
to pass additional information, such as delete the latest version.
See valid option values under the specific datastore class documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.public void del(DKNVPair[] options) throws DKException, java.lang.Exception
options
- options for delete. The option is in the form of
name-value pairs, to allow a more flexible way of passing information,
such as version number to delete. See valid option values under the
specific datastore class documentation.
Note:DKUsageError exception thrown if method is not implemented
DKException
- if a problem is encountered.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |