View Javadoc

1   /**
2    * This file Copyright (c) 2011-2013 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.rendering.template;
35  
36  import java.util.Map;
37  
38  
39  /**
40   * Base interface for all renderables. Defines for instance the template's title, template script and render type.
41   *
42   * @version $Id$
43   */
44  public interface RenderableDefinition {
45  
46      String getId();
47  
48      void setId(String id);
49  
50      String getName();
51  
52      String getRenderType();
53  
54      String getTitle();
55  
56      String getDescription();
57  
58      String getI18nBasename();
59  
60      String getTemplateScript();
61  
62      Map<String, RenderableDefinition> getVariations();
63  
64      /**
65       * An arbitrary list of parameters. Used to omit subclass with getters and setters for each
66       * extra parameter.
67       */
68      Map<String, Object> getParameters();
69  
70      //TODO: use generics again once we get rid of templating-compatibility module
71      Class getModelClass();
72  
73      AutoGenerationConfiguration getAutoGeneration();
74  
75      Boolean getAutoPopulateFromRequest();
76  }