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

Method Summary

Methods

Modifier and Type	Method and Description
List<RenditionDefinition>	getAvailableRenditionDefinitions() Returns a List of registered RenditionDefinition.
DocumentRef	render(DocumentModel sourceDocument, String renditionDefinitionName) Render a document based on the given rendition definition name and returns the Rendition document.

Method Detail

getAvailableRenditionDefinitions

List<RenditionDefinition> getAvailableRenditionDefinitions()

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

render

DocumentRef render(DocumentModel sourceDocument,
                 String renditionDefinitionName)
                   throws RenditionException

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

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