org.nuxeo.ecm.platform.rendition

Interface Renderable

All Known Implementing Classes:

RenderableDocument

public interface Renderable

Interface on an Object that can be used to produce Rendition

Author:

Tiry

Method Summary

Methods

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

Method Detail

getAvailableRenditionDefinitions

List<RenditionDefinition> getAvailableRenditionDefinitions()

Returns RenditionDefinition that are available on the underlying object

Returns:

getRenditionByName

Rendition getRenditionByName(String name)
                             throws RenditionException

Retrieve the Rendition by it's name

Parameters:

name -

Returns:

Throws:

RenditionException

getRenditionByKind

Rendition getRenditionByKind(String name)
                             throws RenditionException

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

Parameters:

name -

Returns:

Throws:

RenditionException