com.sssw.cm.api
Interface EbiDocVersion

All Superinterfaces:

Cloneable, EbiCmElement, EbiComparator, EbiElement, EbiFrameworkElement, Serializable

public interface EbiDocVersion

extends EbiCmElement, EbiComparator, Serializable

This interface defines a Version of a Document's Content.

Field Summary

static String

EL_DOC_VERSION The element type of "Document Version".

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

OP_COPY, OP_MOVE, OP_REMOVE, OP_UPDATE

Fields inherited from interface com.sssw.fw.api.EbiComparator

EQUIVALENT, IN_ORDER, REVERSE_ORDER

Method Summary

String	getComment() Gets the comment supplied by the creator of this Version
byte[]	getData() Gets the actual Content data
InputStream	getDataAsStream() Gets the content data as a stream.
String	getDocumentID() Gets the ID of the Document for which this Version was created
String	getEncoding() Gets the ENCODING of the content
String	getMimeType() Gets the MIME type of the content
Timestamp	getModifiedDate() Gets the date/time of when the Version was created
String	getModifier() Gets the user ID of the person that created the Version
int	getSize() Gets the size of the data
String	getUUID() Gets the UUID of the version
int	getVersionID() Gets the ID of the Version
void	setComment(String comment) Sets the comment.
void	setData(byte[] data) Sets the data bytes.
void	setData(InputStream is) Sets the data from an input stream.
void	setDocumentID(String docID) Sets the document ID.
void	setEncoding(String encoding) Sets the encoding, for this version 5.2, document will take application server's default encoding no matter what encoding you set
void	setMimeType(String mimeType) Sets the mime type.
void	setModifiedDate(Timestamp modDate) Sets the last modified date/time.
void	setSize(int size) Sets the content size.
void	setUUID() Sets/generates the UUID of the version.
void	setUUID(String uuid) Set the UUID of the version.
void	setVersionID(int versionID) Sets the version ID.

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

fromXML, toXML, validateOperation

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

compare

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_VERSION

public static final String EL_DOC_VERSION

The element type of "Document Version".

Method Detail

getVersionID

public int getVersionID()

Gets the ID of the Version

Returns:

the version ID

getUUID

public String getUUID()

Gets the UUID of the version

Returns:

the UUID

getDocumentID

public String getDocumentID()

Gets the ID of the Document for which this Version was created

Returns:

the document ID

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 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

getModifiedDate

public Timestamp getModifiedDate()

Gets the date/time of when the Version was created

Returns:

the date/time of when the Version was created

getModifier

public String getModifier()

Gets the user ID of the person that created the Version

Returns:

the user ID of the person that created the Version

getComment

public String getComment()

Gets the comment supplied by the creator of this Version

Returns:

the text of the comment, or null if none was supplied

setUUID

public void setUUID()

Sets/generates the UUID of the version.

setUUID

public void setUUID(String uuid)

Set the UUID of the version.

Parameters:

uuid -

setVersionID

public void setVersionID(int versionID)

Sets the version ID.

Parameters:

versionID -

setDocumentID

public void setDocumentID(String docID)

Sets the document ID.

Parameters:

docID -

setMimeType

public void setMimeType(String mimeType)

Sets the mime type.

Parameters:

mimeType -

setEncoding

public void setEncoding(String encoding)

Sets the encoding, for this version 5.2, document will take application server's default encoding no matter what encoding you set

Parameters:

encoding -

setData

public void setData(byte[] data)

Sets the data bytes.

Parameters:

data -

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)

Sets the content size.

Parameters:

size -

setComment

public void setComment(String comment)

Sets the comment.

Parameters:

comment -

setModifiedDate

public void setModifiedDate(Timestamp modDate)

Sets the last modified date/time.

Parameters:

modDate -