001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.rendering.api;
023
024import java.io.Writer;
025import java.util.ResourceBundle;
026
027/**
028 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
029 */
030public interface RenderingEngine {
031
032    void setMessageBundle(ResourceBundle messages);
033
034    ResourceBundle getMessageBundle();
035
036    void setResourceLocator(ResourceLocator locator);
037
038    ResourceLocator getResourceLocator();
039
040    void setSharedVariable(String key, Object value);
041
042    /**
043     * Starts the rendering for the given document context.
044     *
045     * @throws RenderingException
046     */
047    void render(String template, Object input, Writer writer) throws RenderingException;
048
049    public View getView(String path);
050
051    public View getView(String path, Object object);
052
053    public void flushCache();
054
055}