|
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 | +--com.ibm.mm.sdk.common.dkBlob | +--com.ibm.mm.sdk.common.DKBlobDD
DKBlobDD: a blob (XDO) represents the contents of a Domino.Doc Document
Other datastores let you manipulate the contents of a part. The Domino.Doc connector does not.
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.DKMessageIdDD |
copyright, DK_DD_MSG_MSGID_DOMDOC, DK_DD_MSG_MSGID_GOVERNOR, DK_DD_MSG_MSGID_NO_ATTR_OBJ, DK_DD_MSG_MSGID_NO_BINDER_OBJ, DK_DD_MSG_MSGID_NO_CABINET_OBJ, DK_DD_MSG_MSGID_NO_DOCUMENT_OBJ, DK_DD_MSG_MSGID_NO_MESSAGE, DK_DD_MSG_MSGID_NO_ROOM_OBJ, DK_DD_MSG_MSGID_NO_SUCCESS, DK_DD_MSG_MSGID_NUL_PARAM |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKBlobDD()
|
|
DKBlobDD(DKBlobDD aDKBlobDD)
Copy constructor. |
|
DKBlobDD(dkDatastore aDatastore)
Constructs the blob and defers initialization until implementation methods are called. |
|
DKBlobDD(dkDatastore aDatastore,
byte[] aByteArr)
Constructs the blob and set object's content. |
Method Summary | |
void |
add()
Not Implemented: Adds the object content from existing file to the datastore |
void |
add(java.lang.String aFullFileName)
Not Implemented: Adds the object content from existing file to the datastore |
dkXDO |
cloneSkeleton()
Clone this XDO with its persistent-id only, that is, with its data content set to empty. |
boolean |
compareData(dkXDO adkXDO)
Compares the content of this object with the content of the other XDO object |
dkBlob |
concatReplace(byte[] aByteArr)
Deprecated. |
dkBlob |
concatReplace(dkBlob adkBlob)
Deprecated. |
void |
copyData(dkXDO adkXDO)
Replaces the content of this object with the content of the other XDO object |
void |
del()
Not Implemented Deletes the object content from datastore |
void |
del(boolean flush)
Not Implemented: Deletes the object content from datastore |
void |
deletingValue()
Deletes value, this function performs as setNull in this class |
boolean |
equals(dkXDOBase adkXDOBase)
Check if the caller's XDO is a "DKBlobDD", and if so compare the objects. |
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 |
getDomDocFileExtension()
Get file Extension |
java.lang.String |
getMimeType()
Get the MIME type for this document |
java.lang.String |
getObjectType()
Gets the object type. |
java.lang.String |
getOpenHandler()
Gets the current program name of the handler for this object instance |
DKPid |
getPid()
Deprecated. Replace by getPidObject() |
java.lang.String |
getPidDocumentId()
Get this document's id |
DKPid |
getPidObject()
Gets a copy of the persistent ID object of this object |
int |
getRank()
Gets the ranking value of a query |
int |
getSize()
Gets the length of this object without retrieving the object |
int |
indexOf(dkBlob adkBlob,
int startpos)
Deprecated. |
int |
indexOf(java.lang.String astring,
int startpos)
Deprecated. |
dkBlob |
insert(dkBlob adkBlob,
int startpos)
Deprecated. |
dkBlob |
insert(java.lang.String astring,
int startpos)
Deprecated. |
boolean |
isContentChanged()
Checks if the part content changed (in memory). |
boolean |
isNull()
Checks if the part content is null (in memory). |
boolean |
isOpenSynchronous()
Gets the current synchronization property |
boolean |
isSet()
Checks if the part content is set (in memory). |
int |
length()
Gets the length of this object content in memory |
java.lang.String |
mimeType()
Gets the MIME type represents this object |
boolean |
notEqual(dkXDOBase adkXDOBase)
Compare the two objects and return the inverse of the equals method. |
void |
open(java.lang.String afileName)
Invoke a document handler for this object. |
dkBlob |
remove(int startpos,
int alength)
Deprecated. |
void |
retrieve()
Retrieves the object content from the datastore to a file name |
void |
retrieve(java.lang.String aFileName)
Retrieves the object content from the datastore to a file name |
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 |
void |
setContent(byte[] aByteArray)
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 |
setDomDocFileExtension(java.lang.String fileExtension)
Set file Extension |
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. |
void |
setNull()
Sets the part content to null (in memory). |
void |
setPid(DKPid aDKPid)
Deprecated. Replace by setPidObject(DKPid aPidXDO) |
void |
setPidDocumentId(java.lang.String documentId)
Set a Domino.Doc document Id. |
void |
setPidObject(DKPid aDKPid)
Sets the pid information of this object with the new provided pid |
void |
setRank(int rank)
Sets the ranking value of a query |
void |
setSize(int aObjectSize)
Sets the object size |
int |
size()
Gets the size of this object content in the datastore |
java.lang.String |
subString(int startpos,
int alength)
Deprecated. |
void |
update()
Note Implemented Updates the object content in datastore with a file |
void |
update(java.lang.String aFileName)
Not Implemented: Updates the object content in datastore with a file |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractXDO |
addExtension, datastore, getAffiliatedType, getClassName, getContentType, getDatastore, getExtension, getOption, getParent, getRootObject, open, protocol, removeExtension, setAffiliatedType, setClassName, setContentType, setDatastore, setOption, setParent, setRootObject |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKBlobDD() throws DKException, java.lang.Exception
public DKBlobDD(dkDatastore aDatastore) throws DKUsageError, java.lang.Exception
aDatastore
- a DKDatastoreDD representing the associated DD datastorecom.ibm.mm.sdk.common.DKUsageError,
- Exception If invalid datastore typepublic DKBlobDD(dkDatastore aDatastore, byte[] aByteArr) throws DKUsageError, java.lang.Exception
aDatastore
- a DKDatastoreDD representing the associated DD datastoreaByteArr
- a byte array to be set as this objects's contentcom.ibm.mm.sdk.common.DKUsageError,
- Exception If invalid datastore typepublic DKBlobDD(DKBlobDD aDKBlobDD) throws DKException, java.lang.Exception
aDKBlobDD
- an instance of DKBlobDDDKException
- If error occurredMethod Detail |
public java.lang.String getObjectType()
public void deletingValue()
public boolean isContentChanged()
isContentChanged
in class dkAbstractXDO
true
if the object content is changed;
false
otherwise.public boolean isSet()
isSet
in class dkAbstractXDO
true
if the object content is set;
false
otherwise.public boolean isNull()
isNull
in class dkAbstractXDO
true
if the object content is null;
false
otherwise.public void setNull()
setNull
in class dkAbstractXDO
public boolean equals(dkXDOBase adkXDOBase) throws DKException
Note: A DKBlobDD is a dkBlob is a dkXDO is a dkXDOBase.
equals
in class dkAbstractXDO
com.ibm.mm.sdk.common.DKException,
- DKXDOError if public boolean notEqual(dkXDOBase adkXDOBase) throws DKException
notEqual
in class dkAbstractXDO
adkXDOBase
- an instance of dkXDOBasetrue
if the objects do not have same type, pid, content and search index
false
otherwise.DKException
- If objects are not the same classequals
public DKPid getPid()
getPid
in class dkAbstractXDO
getPidObject()
public void setPid(DKPid aDKPid) throws DKUsageError
setPid
in class dkAbstractXDO
DKUsageError
- If calledsetPidObject(DKPid aPidXDO)
public DKPid getPidObject()
getPidObject
in class dkAbstractXDO
public void setPidObject(DKPid aDKPid) throws DKException
setPidObject
in class dkAbstractXDO
aPidXDO
- a DKPidXDO objectDKException
- If provided pid is nullpublic void setRank(int rank)
setRank
in class dkAbstractXDO
aRank
- a ranking valuepublic int getRank()
getRank
in class dkAbstractXDO
public void add() throws DKException, java.lang.Exception
add
in class dkAbstractXDO
aFullFileName
- a fully qualified path and file name, default is current directorycom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void add(java.lang.String aFullFileName) throws DKException, java.lang.Exception
add
in class dkAbstractXDO
aFullFileName
- a fully qualified path and file name, default is current directorycom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void retrieve() throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
com.ibm.mm.sdk.common.DKException,
- Exception If error occurredpublic void retrieve(java.lang.String aFileName) throws DKException, java.lang.Exception
retrieve
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directorycom.ibm.mm.sdk.common.DKException,
- Exception If error occurredpublic void update() throws DKException, java.lang.Exception
update
in class dkAbstractXDO
com.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void update(java.lang.String aFileName) throws DKException, java.lang.Exception
update
in class dkAbstractXDO
aFileName
- a fully qualified path and file name, default is current directorycom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractXDO
com.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void del(boolean flush) throws DKException, java.lang.Exception
del
in class dkAbstractXDO
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.com.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void copyData(dkXDO adkXDO) throws DKException, java.lang.Exception
copyData
in class dkAbstractXDO
adkXDO
- the other XDO object must be of the same type as this one (i.e., "DKBlobDD").com.ibm.mm.sdk.common.DKException,
- DKXDOError, if input object not a DKBlobDD.public boolean compareData(dkXDO adkXDO) throws DKException, java.lang.Exception
This method will get the document contents for this object and for the
compareData
in class dkAbstractXDO
adkXDO
- the other XDO object. It must be contain an object of
the same type as this one (i.e., "DKBlobDD").DKException
- = DKXDOError if objects are not the same type.
public void setContent(byte[] aByteArray)
setContent
in class dkAbstractXDO
aByteArray
- a byte arraypublic byte[] getContent() throws DKException, java.lang.Exception
getContent
in class dkAbstractXDO
com.ibm.mm.sdk.common.DKException,
- Exception If object type is differentpublic void getContentToClientFile(java.lang.String aFileName, int fileOption) throws DKException, java.lang.Exception
getContentToClientFile
in class dkAbstractXDO
afileName
- a fully qualified path with file name;
system default path used if no path provided.fileOption
- com.ibm.mm.sdk.common.DKException,
- Exception If error occurredpublic void setContentFromClientFile(java.lang.String afileName) throws DKException
setContentFromClientFile
in class dkAbstractXDO
afileName
- a fully qualified path with file name, default is current directory(if no path)DKException
- If error occurredpublic dkBlob concatReplace(dkBlob adkBlob) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
adkBlob
- another dkBlob objectcom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic dkBlob concatReplace(byte[] aByteArr) throws DKException, java.lang.Exception
concatReplace
in class dkBlob
aByteArr
- a byte array streamDKException
- DKUsageError: Not Implementedpublic int length()
length
in class dkAbstractXDO
public int indexOf(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
astring
- the search string argumentstartpos
- the offset position start to searchcom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic int indexOf(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
indexOf
in class dkBlob
adkBlob
- the _lobData of this dkBlob is the search argumentstartpos
- the offset position start to searchcom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic java.lang.String subString(int startpos, int alength) throws DKException, java.lang.Exception
subString
in class dkBlob
startpos
- the byte offset position start to extractalength
- the length to extractcom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic dkBlob remove(int startpos, int alength) throws DKException, java.lang.Exception
remove
in class dkBlob
startpos
- the byte offset position start to deletealength
- the length to deletecom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic dkBlob insert(java.lang.String astring, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
astring
- the argument string datastartpos
- the byte offset position start to insertcom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic dkBlob insert(dkBlob adkBlob, int startpos) throws DKException, java.lang.Exception
insert
in class dkBlob
adkBlob
- the _lobData of this dkBlob is the argument datastartpos
- the byte offset position start to insertcom.ibm.mm.sdk.common.DKException,
- DKUsageError: Not Implementedpublic void open(java.lang.String afileName) throws DKException, java.lang.Exception
open
in class dkAbstractXDO
afileName
- If null or empty, a temporary file
name will be used for downloading file contents.
If not null or empty, then the file name will be
given to the document handler for handling.setInstanceOpenHandler
public void setInstanceOpenHandler(java.lang.String ahandler, boolean newSynchronousFlag)
setInstanceOpenHandler
in class dkAbstractXDO
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 class dkAbstractXDO
ahandler
- the handler program name to view the contentnewSynchronousFlag
- true
for synchronous process;
false
otherwise.public java.lang.String getOpenHandler()
getOpenHandler
in class dkAbstractXDO
public boolean isOpenSynchronous()
isOpenSynchronous
in class dkAbstractXDO
public dkXDO cloneSkeleton() throws DKUsageError, java.lang.Exception
cloneSkeleton
in class dkAbstractXDO
public void setPidDocumentId(java.lang.String documentId)
public java.lang.String getPidDocumentId()
public java.lang.String getMimeType() throws DKException, java.lang.Exception
For Domino.Doc, the mime type is the file's extension
getMimeType
in class dkAbstractXDO
public java.lang.String mimeType() throws DKException, java.lang.Exception
DKException,
- Exception If error occurredpublic void setMimeType(java.lang.String mimeType)
dkAbstractXDO
Note:DKUsageError exception thrown if method is not implemented
setMimeType
in class dkAbstractXDO
com.ibm.mm.sdk.common.dkAbstractXDO
mimeType
- the MIME typedkAbstractXDO.getMimeType()
public int size() throws DKException, java.lang.Exception
size
in class dkAbstractXDO
public int getSize() throws DKException, java.lang.Exception
DKException
- if error detectedpublic void setSize(int aObjectSize)
public void setDomDocFileExtension(java.lang.String fileExtension)
public java.lang.String getDomDocFileExtension()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |