org.nuxeo.ecm.platform.rendition.service

Interface RenditionService

All Known Implementing Classes:

RenditionServiceImpl

public interface RenditionService

Service handling Rendition Definitions and actual render based on a Rendition Definition

Since:

5.4.1

Author:

Thomas Roger, Tiry

Method Summary

Methods

Modifier and Type	Method and Description
List<RenditionDefinition>	getAvailableRenditionDefinitions(DocumentModel doc) Returns a List of RenditionDefinition available on the given Document.
List<Rendition>	getAvailableRenditions(DocumentModel doc) Returns a List of Rendition available on the given Document.
List<RenditionDefinition>	getDeclaredRenditionDefinitions() Returns a List of registered RenditionDefinition.
List<RenditionDefinition>	getDeclaredRenditionDefinitionsForProviderType(String providerType) Returns a List of registered RenditionDefinition matching a given provider type
Rendition	getRendition(DocumentModel doc, String renditionName) Return the Rendition object for the given DocumentModel and a rendition definition name.
Rendition	getRendition(DocumentModel doc, String renditionName, boolean store) Return the Rendition object for the given DocumentModel and a rendition definition name.
DocumentRef	storeRendition(DocumentModel sourceDocument, String renditionDefinitionName) Render a document based on the given rendition definition name and returns the stored Rendition DocumentRef.

Method Detail

getDeclaredRenditionDefinitions

List<RenditionDefinition> getDeclaredRenditionDefinitions()

Returns a List of registered RenditionDefinition. The order of the List does not depend on the registering order.

getDeclaredRenditionDefinitionsForProviderType

List<RenditionDefinition> getDeclaredRenditionDefinitionsForProviderType(String providerType)

Returns a List of registered RenditionDefinition matching a given provider type

getAvailableRenditionDefinitions

List<RenditionDefinition> getAvailableRenditionDefinitions(DocumentModel doc)

Returns a List of RenditionDefinition available on the given Document. The order of the List does not depend on the registering order.

storeRendition

DocumentRef storeRendition(DocumentModel sourceDocument,
                         String renditionDefinitionName)
                           throws RenditionException

Render a document based on the given rendition definition name and returns the stored Rendition DocumentRef.

Only the user launching the render operation has the Read right on the returned document.

Parameters:

sourceDocument - the document to render

renditionDefinitionName - the rendition definition to use

Returns:

the DocumentRef of the newly created Rendition document.

Throws:

RenditionException

getRendition

Rendition getRendition(DocumentModel doc,
                     String renditionName)
                       throws RenditionException

Return the Rendition object for the given DocumentModel and a rendition definition name.

A stored rendition is returned if found and up to date, a new Rendition is created otherwise.

Parameters:

doc - the document to render

renditionName - the name of the rendition definition

Returns:

the Rendition object

Throws:

RenditionException

getRendition

Rendition getRendition(DocumentModel doc,
                     String renditionName,
                     boolean store)
                       throws RenditionException

Return the Rendition object for the given DocumentModel and a rendition definition name.

A stored rendition is returned if found and up to date, a new (live) Rendition is created otherwise.

If store parameter is true, the new created rendition is stored too and returned

Parameters:

doc - the document to render

renditionName - the name of the rendition definition

store - indicates if the rendition must be stored

Returns:

the Rendition object

Throws:

RenditionException

getAvailableRenditions

List<Rendition> getAvailableRenditions(DocumentModel doc)
                                       throws RenditionException

Returns a List of Rendition available on the given Document.

The order of the List does not depend on the registering order.

The returned rendition may be live or stored

Throws:

RenditionException