org.nuxeo.ecm.platform.rendition

Interface Rendition

All Known Implementing Classes:

AbstractRendition, LazyRendition, LiveRendition, StoredRendition

public interface Rendition

Interface hiding the actual rendition implementation and allowing for Lazy computation of the rendition blobs.

RenditionDefinition is partially wrapper in the Rendition

Since:

5.6

Author:

Tiry

Method Summary

Methods

Modifier and Type	Method and Description
Blob	getBlob() Returns rendered Blob
List<Blob>	getBlobs() Returns rendered Blobs
DocumentModel	getHostDocument() Return the Document hosting the rendition.
String	getIcon() Returns icon file name
String	getKind() Returns the King of the RenditionDefinition
String	getLabel() Returns the RenditionDefinition label s@return
Calendar	getModificationDate() Returns last modification date.
String	getName() Returns the RenditionDefinition name
String	getProviderType() Returns the type of the provider that was used to generate the rendition
boolean	isStored() Indicates if the Rendition is stored or live

Method Detail

getIcon

String getIcon()

Returns icon file name

getName

String getName()

Returns the RenditionDefinition name

getLabel

String getLabel()

Returns the RenditionDefinition label s@return

getKind

String getKind()

Returns the King of the RenditionDefinition

getProviderType

String getProviderType()

Returns the type of the provider that was used to generate the rendition

isStored

boolean isStored()

Indicates if the Rendition is stored or live

getBlob

Blob getBlob()
             throws RenditionException

Returns rendered Blob

Throws:

RenditionException

getBlobs

List<Blob> getBlobs()
                    throws RenditionException

Returns rendered Blobs

Throws:

RenditionException

getHostDocument

DocumentModel getHostDocument()

Return the Document hosting the rendition.

In case of a Live rendition it will be the target document and in case of stored Rendition it will be the Rendition document it self

getModificationDate

Calendar getModificationDate()

Returns last modification date.

Returns current time for live renditions.