com.ibm.spe.core.documents

Interface IDocument

public interface IDocument

Defines the document interface used by the IDocumentProvider.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtension(java.lang.String name, com.ibm.spe.core.context.IDocExtension ext) Adds an extension to this document.
IDocument	copyDocument() Makes a copy of this document.
IDocument	copyDocument(boolean shareDocumentBody) Makes a copy of this document, but optionally the document body is shared with the copy.
void	deleteUnpersisted() Deletes an unpersisted document.
boolean	existInDB() Returns whether or not the document exists in the database.
AckFlag	getAckFlag() Gets the functional acknowledgment flag.
byte[]	getBody() Gets the document body.
org.w3c.dom.Document	getBodyAsLocalDOM() Returns a DOM representation of the document body.
java.lang.String	getBodyName() Gets the body name.
java.lang.String	getCharEncoding() Gets the encoding.
java.lang.String	getContentSubType() Gets the content sub type.
java.lang.String	getContentType() Gets the content type.
java.sql.Timestamp	getCreateTime() Gets the creation time.
java.lang.String	getDocumentId() Gets the document identifier.
java.lang.String	getDocumentName() Gets the document name.
DocumentType	getDocumentType() Gets the document type.
com.ibm.spe.core.context.IDocExtension	getExtension(java.lang.String name, boolean forceLoad) Gets the named extension associated with this Document object.
java.util.Map<java.lang.String,com.ibm.spe.core.context.IDocExtension>	getExtensions() Gets the document extensions Map.
java.io.InputStream	getInputStream() Gets the input stream for this document.
java.io.OutputStream	getOutputStream() Gets the output stream for this document.
java.lang.String	getPreviousDocumentId() Gets the previous document identifier.
long	getSize() Gets the document size.
java.lang.String	getStorageId() Gets the storage identifier.
IResource	getStorageResource() Gets the document storage resource for this document.
java.lang.String	getSubject() Gets the subject.
java.lang.String	getTrackingID() Gets the tracking identifier.
com.ibm.spe.core.doctracking.TrackingRecord	getTrackingRecord() Gets the TrackingRecord.
com.ibm.spe.core.doctracking.TrackingRecord	initTracking(com.ibm.spe.core.context.SPEContext spc, boolean forceInit, boolean disableInheritace) Initializes the tracking.
boolean	isMarkForDelete() Retrieves the delete status for a document.
boolean	isTrackingEnabled() Determines if tracking is enabled.
void	markForDelete(boolean flag) Sets the delete status for the document.
boolean	persist() Persists this document.
com.ibm.spe.core.context.IDocExtension	removeExtension(java.lang.String name) Removes the named document extension.
void	setAckFlag(AckFlag ackFlag) Sets the functional acknowledgment flag.
void	setBody(byte[] body) Sets the document body.
void	setBodyName(java.lang.String bodyName) Sets the body name.
void	setCharEncoding(java.lang.String encoding) Sets document encoding.
void	setContentSubType(java.lang.String contentSubType) Sets the content sub type.
void	setContentType(java.lang.String contentType) Sets the content type.
void	setDocumentName(java.lang.String docName) Sets the document name.
void	setDocumentType(DocumentType docType) Sets the document type.
void	setSize(long size) Sets the document size.
void	setSubject(java.lang.String subject) Sets the subject.
void	setTrackingID(java.lang.String id) Sets the tracking identifier.
void	track(java.lang.String name, java.lang.String value, java.lang.String scope) Adds the provided correlation tracking information to this document.

Method Detail

persist

boolean persist()
                throws java.io.IOException

Persists this document.

Returns:

true if persisted, otherwise false.

Throws:

java.io.IOException - if an error occurs.

getStorageResource

IResource getStorageResource()

Gets the document storage resource for this document.

Returns:

The document storage resource.

getDocumentId

java.lang.String getDocumentId()

Gets the document identifier.

Returns:

The document identifier.

getStorageId

java.lang.String getStorageId()

Gets the storage identifier.

Returns:

The storage identifier.

setDocumentType

void setDocumentType(DocumentType docType)

Sets the document type.

Parameters:

docType - The document type to set.

getDocumentType

DocumentType getDocumentType()

Gets the document type.

Returns:

The document type.

setAckFlag

void setAckFlag(AckFlag ackFlag)

Sets the functional acknowledgment flag.

Parameters:

ackFlag - The functional acknowledgment to set.

getAckFlag

AckFlag getAckFlag()

Gets the functional acknowledgment flag.

Returns:

The functional acknowledgment flag.

setSubject

void setSubject(java.lang.String subject)

Sets the subject.

Parameters:

subject - The subject to set.

getSubject

java.lang.String getSubject()

Gets the subject.

Returns:

The subject.

setContentType

void setContentType(java.lang.String contentType)

Sets the content type.

Parameters:

contentType - The content type to set.

getContentType

java.lang.String getContentType()

Gets the content type.

Returns:

The content type.

setContentSubType

void setContentSubType(java.lang.String contentSubType)

Sets the content sub type.

Parameters:

contentSubType - The content sub type to set.

getContentSubType

java.lang.String getContentSubType()

Gets the content sub type.

Returns:

The content sub type.

getPreviousDocumentId

java.lang.String getPreviousDocumentId()

Gets the previous document identifier.

Returns:

The previous document identifier.

setBodyName

void setBodyName(java.lang.String bodyName)

Sets the body name.

Parameters:

bodyName - The body name to set.

getBodyName

java.lang.String getBodyName()

Gets the body name.

Returns:

The body name.

setCharEncoding

void setCharEncoding(java.lang.String encoding)

Sets document encoding.

Parameters:

encoding - The document encoding to set.

getCharEncoding

java.lang.String getCharEncoding()

Gets the encoding.

Returns:

The encoding.

setDocumentName

void setDocumentName(java.lang.String docName)

Sets the document name.

Parameters:

docName - The document name to set.

getDocumentName

java.lang.String getDocumentName()

Gets the document name.

Returns:

The document name.

getCreateTime

java.sql.Timestamp getCreateTime()

Gets the creation time.

Returns:

The creation time.

copyDocument

IDocument copyDocument()
                       throws java.io.IOException

Makes a copy of this document. The document body is shared with the copy.

Returns:

A copy of this document where the document body is shared with the source document.

Throws:

java.io.IOException - if an error occurs.

copyDocument

IDocument copyDocument(boolean shareDocumentBody)
                       throws java.io.IOException

Makes a copy of this document, but optionally the document body is shared with the copy.

Parameters:

shareDocumentBody - A boolean, if true then the source document body is shared with the copy. Otherwise, if false then the copy will have its own storage area with a copy of the document body.

Returns:

A copy of this document.

Throws:

java.io.IOException - if an error occurs.

setSize

void setSize(long size)

Sets the document size.

Parameters:

size - The size to set.

getSize

long getSize()

Gets the document size.

Returns:

The document size.

addExtension

void addExtension(java.lang.String name,
                com.ibm.spe.core.context.IDocExtension ext)

Adds an extension to this document.

Parameters:

name - The extension key.

ext - The extension to add.

removeExtension

com.ibm.spe.core.context.IDocExtension removeExtension(java.lang.String name)
                                                       throws java.io.IOException

Removes the named document extension.

Parameters:

name - The document extension name (key).

Returns:

The document extension that was removed.

Throws:

java.io.IOException - if an error occurs.

getExtension

com.ibm.spe.core.context.IDocExtension getExtension(java.lang.String name,
                                                  boolean forceLoad)
                                                    throws java.io.IOException

Gets the named extension associated with this Document object.

Parameters:

name - The extension key.

forceLoad - Determines whether to force a new load from the database.

Returns:

The document extension.

Throws:

java.io.IOException - if an error occurs.

getExtensions

java.util.Map<java.lang.String,com.ibm.spe.core.context.IDocExtension> getExtensions()

Gets the document extensions Map.

Returns:

A Map with all the document extensions.

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException

Gets the input stream for this document.

Returns:

The InputStream for this document.

Throws:

java.io.IOException

getOutputStream

java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Gets the output stream for this document.

Returns:

The OutputStream for this document.

Throws:

java.lang.Exception - if an error occurs.

java.io.IOException

setBody

void setBody(byte[] body)
             throws java.io.IOException

Sets the document body.

Parameters:

body - The data to set in the document body.

Throws:

java.io.IOException - if an error occurs.

getBody

byte[] getBody()
               throws java.io.IOException

Gets the document body.

Returns:

The document body as a byte array.

Throws:

java.io.IOException - if an error occurs.

isTrackingEnabled

boolean isTrackingEnabled()

Determines if tracking is enabled.

Returns:

A boolean true if tracking is enabled, otherwise false.

setTrackingID

void setTrackingID(java.lang.String id)

Sets the tracking identifier.

Parameters:

id - The tracking identifier to set.

getTrackingID

java.lang.String getTrackingID()

Gets the tracking identifier.

Returns:

The tracking identifier.

getTrackingRecord

com.ibm.spe.core.doctracking.TrackingRecord getTrackingRecord()

Gets the TrackingRecord.

Returns:

The TrackingRecord.

initTracking

com.ibm.spe.core.doctracking.TrackingRecord initTracking(com.ibm.spe.core.context.SPEContext spc,
                                                       boolean forceInit,
                                                       boolean disableInheritace)

Initializes the tracking.

Parameters:

spc - The SPEContext.

forceInit - Sets the tracking flag for subsequent calls to isTrackingEnabled.

disableInheritace - Determines whether to re-initialize the TrackingRecord.

Returns:

The TrackingRecord.

track

void track(java.lang.String name,
         java.lang.String value,
         java.lang.String scope)
           throws TrackingException

Adds the provided correlation tracking information to this document.

Parameters:

name - The correlation name.

value - The correlation value.

scope - The correlation scope.

Throws:

TrackingException - if an error occurs adding the tracking information.

deleteUnpersisted

void deleteUnpersisted()

Deletes an unpersisted document.

getBodyAsLocalDOM

org.w3c.dom.Document getBodyAsLocalDOM()
                                       throws java.lang.Exception

Returns a DOM representation of the document body.

Throws:

java.lang.Exception - if an error occurs.

markForDelete

void markForDelete(boolean flag)

Sets the delete status for the document.

Parameters:

flag - A boolean, if true then the document is marked for deletion.

isMarkForDelete

boolean isMarkForDelete()

Retrieves the delete status for a document.

Returns:

A boolean, if true then the document is marked for deletion. Otherwise, false.

existInDB

boolean existInDB()

Returns whether or not the document exists in the database.

Returns:

A boolean, if true then the document exists in the database. Otherwise, false.