com.sssw.cm.api
Interface EbiDocContent

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, Serializable

All Known Subinterfaces:

EbiQueryResult

public interface EbiDocContent

extends EbiCmElement, Serializable

EbiDocContent defines the notion of a Document's Content. The Document Content is associated with a specific Document by the document's ID and is characterized by its MIME type, size, and the actual content bytes.
The Document Content is actually the published version of the Document. A Document may have several existing versions yet none published at the moment. If a version is published, then Document Content has the knowledge of which version from the version list it came from (see getVersionID).

Field Summary

static String

EL_DOC_CONTENT The element type of "Document Content".

Fields inherited from interface com.sssw.cm.api.EbiCmElement

OP_COPY, OP_MOVE, OP_REMOVE, OP_UPDATE

Method Summary

byte[]	getData() Gets the actual Content data.
InputStream	getDataAsStream() Gets the content data as a stream.
String	getDocumentID() Gets the ID of the Document whose Content is represented by this EbiDocContent.
String	getEncoding() Gets the ENCODING of the Content.
String	getMimeType() Gets the MIME type of the Content.
String	getRepositoryID() Gets the ID of the repository where this content object resides.
int	getSize() Gets the size of the data
String	getUUID() Gets the UUID of the Content.
int	getVersionID() Gets the ID of the version of the Document that was published and is represented by this EbiDocContent.
void	setData(byte[] data) Set the data bytes.
void	setData(InputStream is) Sets the data from an input stream.
void	setDocumentID(String docID) Set the document ID.
void	setEncoding(String encoding) Set the encoding, for the version 5.2, encoding will be set to application server's default encoding no matter what encoding user chooses
void	setLastModified(Timestamp modDateTime) Set the last modified date/time.
void	setMimeType(String mimeType) Set the mime type.
void	setSize(int size) Set the data size.
void	setUUID() Set/generate the UUID of the content.
void	setUUID(String uuid) Set the UUID of the content.
void	setVersionID(int versionID) Set the version ID.

Methods implemented from interface com.sssw.cm.api.EbiCmElement

fromXML, toXML, validateOperation

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_DOC_CONTENT

public static final String EL_DOC_CONTENT

The element type of "Document Content".

See Also:

EbiElement.getType()

Method Detail

getDocumentID

public String getDocumentID()

Gets the ID of the Document whose Content is represented by this EbiDocContent.

Returns:

the Document ID

getUUID

public String getUUID()

Gets the UUID of the Content.

Returns:

the UUID

getMimeType

public String getMimeType()

Gets the MIME type of the Content.

Returns:

the MIME type

getEncoding

public String getEncoding()

Gets the ENCODING of the Content.

Returns:

the ENCODING

getData

public byte[] getData()

Gets the actual Content data.

Returns:

byte array with the data

getDataAsStream

public InputStream getDataAsStream()
                            throws EboUnrecoverableSystemException

Gets the content data as a stream.

Returns:

the input stream with the data, or null if none available

getSize

public int getSize()

Gets the size of the data

Returns:

the size of the data

getVersionID

public int getVersionID()

Gets the ID of the version of the Document that was published and is represented by this EbiDocContent.

Returns:

version ID

setDocumentID

public void setDocumentID(String docID)

Set the document ID.

Parameters:

docID - the document ID

setUUID

public void setUUID()

Set/generate the UUID of the content.

getRepositoryID

public String getRepositoryID()

Gets the ID of the repository where this content object resides.

Returns:

the repository UUID

setUUID

public void setUUID(String uuid)

Set the UUID of the content.

Parameters:

uuid - the UUID of the content

setMimeType

public void setMimeType(String mimeType)

Set the mime type.

Parameters:

mimeType - the MIME type

setEncoding

public void setEncoding(String encoding)

Set the encoding, for the version 5.2, encoding will be set to application server's default encoding no matter what encoding user chooses

Parameters:

encoding - the ENCODING

setData

public void setData(byte[] data)

Set the data bytes.

Parameters:

data - the data bytes

setData

public void setData(InputStream is)
             throws EboUnrecoverableSystemException

Sets the data from an input stream.

Parameters:

is - the data input stream

setSize

public void setSize(int size)

Set the data size.

Parameters:

size - the data size

setVersionID

public void setVersionID(int versionID)

Set the version ID.

Parameters:

versionID - the version ID

setLastModified

public void setLastModified(Timestamp modDateTime)

Set the last modified date/time.

Parameters:

modDateTime - the last modified date/time