org.nuxeo.ecm.platform.rendition.adapter

Class RenderableDocument

java.lang.Object

org.nuxeo.ecm.platform.rendition.adapter.RenderableDocument

All Implemented Interfaces:

Renderable

public class RenderableDocument
extends Object
implements Renderable

Default implementation for Renderable interface.

This is a simple wrapper around the RenditionService in the context of a given DocumentModel

Author:

Tiry

Constructor Summary

Constructors

Constructor and Description
RenderableDocument(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
List<RenditionDefinition>	getAvailableRenditionDefinitions() Returns RenditionDefinition that are available on the underlying object
Rendition	getRenditionByKind(String kind) Retrieve the Rendition by it's king (first match rendition is returned)
Rendition	getRenditionByName(String name) Retrieve the Rendition by it's name

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenderableDocument

public RenderableDocument(DocumentModel doc)

Method Detail

getAvailableRenditionDefinitions

public List<RenditionDefinition> getAvailableRenditionDefinitions()

Description copied from interface: Renderable

Returns RenditionDefinition that are available on the underlying object

Specified by:

getAvailableRenditionDefinitions in interface Renderable

Returns:

getRenditionByName

public Rendition getRenditionByName(String name)
                             throws RenditionException

Description copied from interface: Renderable

Retrieve the Rendition by it's name

Specified by:

getRenditionByName in interface Renderable

Returns:

Throws:

RenditionException

getRenditionByKind

public Rendition getRenditionByKind(String kind)
                             throws RenditionException

Description copied from interface: Renderable

Retrieve the Rendition by it's king (first match rendition is returned)

Specified by:

getRenditionByKind in interface Renderable

Returns:

Throws:

RenditionException