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() Return rendered Blob
List<Blob>	getBlobs() Return rendered Blobs
DocumentModel	getHostDocument() Return the Document hosting the rendition.
String	getIcon() get icon file name
String	getKind() Get the King of the RenditionDefinition
String	getLabel() get the RenditionDefinition label s@return
Calendar	getModificationDate() Get last modification date.
String	getName() get the RenditionDefinition name
String	getProviderType() return 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()

get icon file name

Returns:

getName

String getName()

get the RenditionDefinition name

Returns:

getLabel

String getLabel()

get the RenditionDefinition label s@return

getKind

String getKind()

Get the King of the RenditionDefinition

Returns:

getProviderType

String getProviderType()

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

Returns:

isStored

boolean isStored()

Indicates if the Rendition is stored or live

Returns:

getBlob

Blob getBlob()
             throws RenditionException

Return rendered Blob

Returns:

Throws:

RenditionException

getBlobs

List<Blob> getBlobs()
                    throws RenditionException

Return rendered Blobs

Returns:

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

Returns:

getModificationDate

Calendar getModificationDate()

Get last modification date.

returns current time for live renditions

Returns: