|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
dkXDO: a common abstract class that can represent a complex UDT(User Defined Type) or LOB(Large Object).
Method Summary | |
void |
add()
Adds the object content from memory to the datastore |
void |
add(java.lang.String aFullFileName)
Adds the object content from existing file to the datastore |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Add the extension object. |
dkXDO |
cloneSkeleton()
Clone this XDO with its persistent-id only, that is, with its data content set to empty. |
boolean |
compareData(dkXDO aXDO)
Compares the content of this object with the content of the other XDO object |
void |
copyData(dkXDO aXDO)
Replaces the content of this object with the content of the other XDO object |
dkDatastore |
datastore()
Deprecated. Replace by getDatastore |
void |
del()
Deletes the object content from datastore |
void |
del(boolean flush)
Deletes the object content from datastore |
int |
getAffiliatedType()
Gets the affiliated type of this object. |
java.lang.String |
getClassName()
Gets the class name of this object. |
byte[] |
getContent()
Gets the content of this object |
void |
getContentToClientFile(java.lang.String afileName,
int fileOption)
Copies the lob data of this object to the given file |
java.lang.String |
getContentType()
Gets the content type of this object. |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object |
dkExtension |
getExtension(java.lang.String extensionName)
Gets the extension object. |
java.lang.String |
getMimeType()
Gets the MIME type of this object. |
java.lang.Object |
getOption(int option)
Gets the option value of a specified option |
DKPid |
getPid()
Deprecated. Replace by getPidObject() |
DKPid |
getPidObject()
Gets a copy of the persistent ID object of this object |
int |
getRank()
Gets the ranking value of a query |
boolean |
isContentChanged()
Checks if the part content changed (in memory). |
boolean |
isSet()
Checks if the part content is set (in memory). |
int |
length()
Gets the length of this object content in memory |
void |
removeExtension(java.lang.String extensionName)
Remove the extension object. |
void |
retrieve()
Retrieves the object content from the datastore to the memory buffer |
void |
retrieve(java.lang.String aFullFileName)
Retrieves the object content from the datastore to a file name |
void |
setAffiliatedType(int affiliatedType)
Sets the affiliated type for this object. |
void |
setClassName(java.lang.String className)
Sets the class name of this object. |
void |
setContent(byte[] aByteArr)
Sets the content of this object with a byte array stream argument |
void |
setContentFromClientFile(java.lang.String afileName)
Replaces the lob data of this object with the contents of the file afileName |
void |
setContentType(java.lang.String contentType)
Sets the content type for this object. |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object |
void |
setMimeType(java.lang.String mimeType)
Sets the MIME type for this object. |
void |
setOption(int option,
java.lang.Object value)
Sets the option value to a specified option |
void |
setPid(DKPid aPid)
Deprecated. Replace by setPidObject(DKPid aPid) |
void |
setPidObject(DKPid aPid)
Sets the pid information of this object with the new provided pid |
void |
setRank(int aRank)
Sets the ranking value of a query |
int |
size()
Gets the size of this object content in the datastore |
void |
update()
Updates the object content in datastore with the content in memory |
void |
update(java.lang.String aFullFileName)
Updates the object content in datastore with a file |
Methods inherited from interface com.ibm.mm.sdk.common.dkXDOBase |
equals, getOpenHandler, isNull, isOpenSynchronous, notEqual, open, open, protocol, setClassOpenHandler, setInstanceOpenHandler, setNull |
Methods inherited from interface com.ibm.mm.sdk.common.dkDataObjectBase |
getObjectType, getParent, getRootObject, setParent, setRootObject |
Method Detail |
public void setPid(DKPid aPid) throws DKUsageError
Note:DKUsageError exception thrown if method is not implemented
aPid
- a DKPid or DKPidXDO objectDKUsageError
- If provided pid is nullsetPidObject(DKPid aPidXDO)
public DKPid getPid()
getPidObject()
public DKPid getPidObject()
public void setPidObject(DKPid aPid) throws DKException
aPid
- a DKPid or DKPidXDO objectDKException
- If provided pid is nullpublic void add() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException,
- Exception If error occurredpublic void add(java.lang.String aFullFileName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
aFullFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void retrieve() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic void retrieve(java.lang.String aFullFileName) throws DKException, java.lang.Exception
aFullFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void update() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException,
- Exception If error occurredpublic void update(java.lang.String aFullFileName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
aFullFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void del() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
DKException,
- Exception If error occurredpublic void del(boolean flush) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
flush
- if true the memory content will be flush, if false
and content is not set, the object will be retreived before delete it.
The default is flush.DKException,
- Exception If error occurredpublic void getContentToClientFile(java.lang.String afileName, int fileOption) throws DKException, java.lang.Exception
afileName
- a fully qualified path with file name, default is current directory(if no path)fileOption
- 1 will create or overwrite an existing file; 2 will only create file, but
will also throw an exception if the file already exists; 3 appends to an existing fileDKException,
- Exception If error occurredpublic void setContentFromClientFile(java.lang.String afileName) throws DKException
afileName
- a fully qualified path with file name, default is current directory(if no path)DKException
- If error occurredpublic boolean isContentChanged()
true
if the object content is changed;
false
otherwise.public boolean isSet()
true
if the object content is set;
false
otherwise.public void copyData(dkXDO aXDO) throws DKException, java.lang.Exception
adkXDO
- the other XDO objectDKException,
- Exception If error occurredpublic boolean compareData(dkXDO aXDO) throws DKException, java.lang.Exception
adkXDO
- the other XDO objectDKException,
- Exception If object type is differentpublic int size() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public int length() throws DKException, java.lang.Exception
public dkDatastore datastore()
getDatastore()
public dkDatastore getDatastore()
public void setDatastore(dkDatastore ds)
ds
- a dkDatastorepublic dkXDO cloneSkeleton() throws DKUsageError, java.lang.Exception
public int getAffiliatedType() throws DKException, java.lang.Exception
public void setAffiliatedType(int affiliatedType) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
affiliatedType
- the affiliated typegetAffiliatedType()
public java.lang.String getMimeType() throws DKException, java.lang.Exception
public void setMimeType(java.lang.String mimeType) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
mimeType
- the MIME typegetMimeType()
public java.lang.String getContentType() throws DKException, java.lang.Exception
public void setContentType(java.lang.String contentType) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
contentType
- the content typegetContentType()
public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
extensionName
- the extension nameextensionObj
- a source extension objectDKException,
- Exception If error occurredpublic void removeExtension(java.lang.String extensionName) throws DKException
Note:DKUsageError exception thrown if method is not implemented
extensionName
- the extension nameDKException
- If error occurredpublic dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
extensionName
- the extension nameDKException,
- Exception If error occurredpublic byte[] getContent() throws DKException, java.lang.Exception
DKException,
- Exception If object type is differentpublic void setContent(byte[] aByteArr) throws DKException
aByteArr
- a byte arraypublic java.lang.Object getOption(int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
option
- a specified optionpublic void setOption(int option, java.lang.Object value) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
option
- a specified optionvalue
- an object contains the option valuepublic void setRank(int aRank)
aRank
- a ranking valuepublic int getRank()
public java.lang.String getClassName() throws DKException, java.lang.Exception
public void setClassName(java.lang.String className) throws DKException, java.lang.Exception
className
- the class name
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |