Package 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
Modifier and TypeMethodDescriptiongetBlob()
Returns the rendered Blob ornull
if none.getBlobs()
Returns the rendered Blobs ornull
if none.Returns theRenditionDefinition
CMIS nameReturn the Document hosting the rendition.getIcon()
Returns icon file namegetKind()
Returns the King of theRenditionDefinition
getLabel()
Returns theRenditionDefinition
labelReturns last modification date.getName()
Returns theRenditionDefinition
nameReturns the type of the provider that was used to generate the renditionboolean
Checks if this rendition's computation has completed.boolean
isStored()
Indicates if the Rendition is stored or live
-
Method Details
-
getIcon
String getIcon()Returns icon file name -
getName
String getName()Returns theRenditionDefinition
name -
getCmisName
String getCmisName()Returns theRenditionDefinition
CMIS name- Since:
- 7.3
-
getLabel
String getLabel()Returns theRenditionDefinition
label -
getKind
String getKind()Returns the King of theRenditionDefinition
-
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()Returns the rendered Blob ornull
if none. -
getBlobs
Returns the rendered Blobs ornull
if none. -
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.
-
isCompleted
boolean isCompleted()Checks if this rendition's computation has completed.- Since:
- 7.10
-