org.nuxeo.ecm.platform.rendering

Interface RenderingEngine

All Known Implementing Classes:

DocumentRenderingEngine, FreemarkerRenderingEngine, NotificationsRenderingEngine

public interface RenderingEngine

A RenderingEngine will be instantiated by the RenderingService according with the descriptor specified for it. The specific implementation of a RenderingEngine must be in classpath for it to be instantiated and used.

Author:

Dragos Mihalache

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormatName()
RenderingResult	process(RenderingContext ctx) Processes the given context and return a rendering result.

Method Detail

getFormatName

String getFormatName()

process

RenderingResult process(RenderingContext ctx)
                        throws RenderingException

Processes the given context and return a rendering result.

The processing must never return null. If some error occurs it must throw an exception.

Parameters:

ctx - the context to process

Throws:

RenderingException