|
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.dkAbstractXDO
dkAbstractXDO: a common abstract class that can represent a complex UDT(User Defined Type) or LOB(Large Object).
Method Summary | |
void |
add()
Adds the content object from memory to the datastore |
void |
add(java.lang.String aFullFileName)
Adds the content object from existing file to the datastore |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Add the extension object. |
abstract 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 |
abstract 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 content object from datastore |
void |
del(boolean flush)
Deletes the content object from datastore |
boolean |
equals(dkXDOBase aXDOBase)
Check if the objects have the same value |
int |
getAffiliatedType()
Gets the affiliated type of this object. |
java.lang.String |
getClassName()
Gets the class name of this object. |
abstract byte[] |
getContent()
Gets the content of this object |
abstract 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.String |
getOpenHandler()
Gets the current program name of the handler for this object instance |
java.lang.Object |
getOption(int option)
Gets the option value of a specified option |
dkDataObjectBase |
getParent()
Gets the parent object |
DKPid |
getPid()
Deprecated. Replace by getPidObject() |
abstract DKPid |
getPidObject()
Gets a copy of the persistent ID object of this object |
int |
getRank()
Gets the ranking value of a query |
dkDataObjectBase |
getRootObject()
Gets the root object |
abstract boolean |
isContentChanged()
Checks if the part content changed (in memory). |
abstract boolean |
isNull()
Checks if the part content is null (in memory). |
boolean |
isOpenSynchronous()
Gets the current synchronization property |
abstract boolean |
isSet()
Checks if the part content is set (in memory). |
int |
length()
Gets the length of this content object in memory |
boolean |
notEqual(dkXDOBase aXDOBase)
|
void |
open()
Unloads the content object to a client file with a system generated name and then synchronously invoking a default handler against the file. |
void |
open(java.lang.String afileName)
Unloads the content object to a file afileName provided by the application and then synchronously invoking a default handler against the file. |
short |
protocol()
Returns the protocol supported by this object. |
void |
removeExtension(java.lang.String extensionName)
Remove the extension object. |
void |
retrieve()
Retrieves the content object from the datastore to the memory buffer |
void |
retrieve(java.lang.String aFullFileName)
Retrieves the content object 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 |
setClassOpenHandler(java.lang.String ahandler,
boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object class |
abstract void |
setContent(byte[] aByteArr)
Sets the content of this object with a byte array stream argument |
abstract 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 |
setInstanceOpenHandler(java.lang.String ahandler,
boolean newSynchronousFlag)
Sets the executable handler program name and whether this handler should be invoked synchronously or asynchronously for this object instant |
void |
setMimeType(java.lang.String mimeType)
Sets the MIME type for this object. |
abstract void |
setNull()
Sets the part content to null (in memory). |
void |
setOption(int option,
java.lang.Object value)
Sets the option value to a specified option |
void |
setParent(dkDataObjectBase parentObject)
Sets the parent object |
void |
setPid(DKPid aPid)
Deprecated. Replace by setPidObject(DKPid aPid) |
abstract 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 |
void |
setRootObject(dkDataObjectBase rootObject)
Sets the root object |
int |
size()
Gets the size of this content object in the datastore |
void |
update()
Updates the content object in datastore with the content in memory |
void |
update(java.lang.String aFullFileName)
Updates the content object in datastore with a file |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.mm.sdk.common.dkDataObjectBase |
getObjectType |
Method Detail |
public abstract void setNull()
setNull
in interface dkXDOBase
public abstract boolean isNull()
isNull
in interface dkXDOBase
true
if the object content is null;
false
otherwise.public boolean equals(dkXDOBase aXDOBase) throws DKException
equals
in interface dkXDOBase
adkXDOBase
- an instance of dkXDOBasetrue
if the objects have the same value
false
otherwise.DKException,
- Exception If error occurredpublic boolean notEqual(dkXDOBase aXDOBase) throws DKException
notEqual
in interface dkXDOBase
public void setPid(DKPid aPid) throws DKUsageError
Note:DKUsageError exception thrown if method is not implemented
setPid
in interface dkXDO
aPid
- a DKPid or DKPidXDO objectDKUsageError
- If provided pid is nullsetPidObject(DKPid aPid)
public DKPid getPid()
getPid
in interface dkXDO
getPidObject()
public abstract DKPid getPidObject()
getPidObject
in interface dkXDO
public abstract void setPidObject(DKPid aPid) throws DKException
setPidObject
in interface dkXDO
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
add
in interface dkXDO
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
add
in interface dkXDO
aFullFileName
- a fully qualified path and file name, default is current directoryDKException,
- Exception If error occurredpublic void retrieve() throws DKException, java.lang.Exception
retrieve
in interface dkXDO
DKException,
- Exception If error occurredpublic void retrieve(java.lang.String aFullFileName) throws DKException, java.lang.Exception
retrieve
in interface dkXDO
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
update
in interface dkXDO
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
update
in interface dkXDO
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
del
in interface dkXDO
DKException,
- Exception If error occurredpublic void del(boolean flush) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
del
in interface dkXDO
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 abstract void getContentToClientFile(java.lang.String afileName, int fileOption) throws DKException, java.lang.Exception
getContentToClientFile
in interface dkXDO
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 abstract void setContentFromClientFile(java.lang.String afileName) throws DKException
setContentFromClientFile
in interface dkXDO
afileName
- a fully qualified path with file name, default is current directory(if no path)DKException
- If error occurredpublic abstract boolean isContentChanged()
isContentChanged
in interface dkXDO
true
if the content object is changed;
false
otherwise.public abstract boolean isSet()
isSet
in interface dkXDO
true
if the content object is set;
false
otherwise.public abstract void copyData(dkXDO aXDO) throws DKException, java.lang.Exception
copyData
in interface dkXDO
adkXDO
- the other XDO objectDKException,
- Exception If error occurredpublic boolean compareData(dkXDO aXDO) throws DKException, java.lang.Exception
compareData
in interface dkXDO
adkXDO
- the other XDO objectDKException,
- Exception If object type is differentpublic short protocol()
protocol
in interface dkXDOBase
public int size() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
size
in interface dkXDO
public int length() throws DKException, java.lang.Exception
length
in interface dkXDO
public dkDatastore datastore()
datastore
in interface dkXDO
getDatastore()
public dkDatastore getDatastore()
getDatastore
in interface dkXDO
public void setDatastore(dkDatastore ds)
setDatastore
in interface dkXDO
ds
- a dkDatastorepublic abstract dkXDO cloneSkeleton() throws DKUsageError, java.lang.Exception
cloneSkeleton
in interface dkXDO
public int getAffiliatedType() throws DKException, java.lang.Exception
getAffiliatedType
in interface dkXDO
public void setAffiliatedType(int affiliatedType) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
setAffiliatedType
in interface dkXDO
affiliatedType
- the affiliated typegetAffiliatedType()
public java.lang.String getMimeType() throws DKException, java.lang.Exception
getMimeType
in interface dkXDO
public void setMimeType(java.lang.String mimeType) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
setMimeType
in interface dkXDO
mimeType
- the MIME typegetMimeType()
public java.lang.String getContentType() throws DKException, java.lang.Exception
getContentType
in interface dkXDO
public void setContentType(java.lang.String contentType) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
setContentType
in interface dkXDO
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
addExtension
in interface dkXDO
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
removeExtension
in interface dkXDO
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
getExtension
in interface dkXDO
extensionName
- the extension nameDKException,
- Exception If error occurredpublic abstract byte[] getContent() throws DKException, java.lang.Exception
getContent
in interface dkXDO
DKException,
- Exception If object type is differentpublic abstract void setContent(byte[] aByteArr) throws DKException
setContent
in interface dkXDO
aByteArr
- a byte arraypublic java.lang.Object getOption(int option) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
getOption
in interface dkXDO
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
setOption
in interface dkXDO
option
- a specified optionvalue
- an object contains the option valuepublic void setRank(int aRank)
setRank
in interface dkXDO
aRank
- a ranking valuepublic int getRank()
getRank
in interface dkXDO
public void open() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
open
in interface dkXDOBase
DKException,
- Exception If error occurredpublic void open(java.lang.String afileName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
open
in interface dkXDOBase
afileName
- a provided file nameDKException,
- Exception If error occurredpublic void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setInstanceOpenHandler
in interface dkXDOBase
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public void setClassOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setClassOpenHandler
in interface dkXDOBase
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public java.lang.String getOpenHandler()
getOpenHandler
in interface dkXDOBase
public boolean isOpenSynchronous()
isOpenSynchronous
in interface dkXDOBase
public dkDataObjectBase getParent()
getParent
in interface dkDataObjectBase
public void setParent(dkDataObjectBase parentObject)
setParent
in interface dkDataObjectBase
parent
- the parent objectpublic dkDataObjectBase getRootObject()
getRootObject
in interface dkDataObjectBase
public void setRootObject(dkDataObjectBase rootObject)
setRootObject
in interface dkDataObjectBase
rootObject
- the root objectpublic java.lang.String getClassName() throws DKException, java.lang.Exception
getClassName
in interface dkXDO
public void setClassName(java.lang.String className) throws DKException, java.lang.Exception
setClassName
in interface dkXDO
className
- the class name
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |