org.eclipse.stardust.engine.api.runtime

Interface Document

All Superinterfaces:

DocumentInfo, Resource, ResourceInfo, Serializable

All Known Implementing Classes:

DmsDocumentBean

public interface Document
extends DocumentInfo, Resource

The Document interface represents an existing JCR document.

Version:

$Revision$

Author:

rsauer

Method Summary

Methods

Modifier and Type	Method and Description
String	getEncoding() Gets the encoding of the document content.
String	getRevisionComment() Gets the version comment of the revision represented by this Document object.
String	getRevisionId() Gets the id of the revision represented by this Document object.
String	getRevisionName() Gets the name of the revision represented by this Document object.
long	getSize() Gets the size of a the document content in bytes.
List<String>	getVersionLabels() Gets all labels assigned to the revision represented by this Document object.

Methods inherited from interface org.eclipse.stardust.engine.api.runtime.DocumentInfo

getContentType, getDocumentAnnotations, getDocumentType, setContentType, setDocumentAnnotations, setDocumentType

Methods inherited from interface org.eclipse.stardust.engine.api.runtime.Resource

getId, getPath, getRepositoryId

Methods inherited from interface org.eclipse.stardust.engine.api.runtime.ResourceInfo

getDateCreated, getDateLastModified, getDescription, getName, getOwner, getProperties, getProperty, setDescription, setName, setOwner, setProperties, setProperty

Method Detail

getSize

long getSize()

Gets the size of a the document content in bytes.

Returns:

the size of a the document content in bytes.

getRevisionId

String getRevisionId()

Gets the id of the revision represented by this Document object.

Returns:

the id of the revision represented by this Document object.

getRevisionName

String getRevisionName()

Gets the name of the revision represented by this Document object.

Returns:

the name of the revision represented by this Document object.

getRevisionComment

String getRevisionComment()

Gets the version comment of the revision represented by this Document object.

Returns:

the version comment of the revision represented by this Document object.

getVersionLabels

List<String> getVersionLabels()

Gets all labels assigned to the revision represented by this Document object.

Returns:

all labels assigned to the revision represented by this Document object.

getEncoding

String getEncoding()

Gets the encoding of the document content.

Returns:

the encoding of the document content.