1 /**
2 * This file Copyright (c) 2011-2015 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 info.magnolia.config.NamedDefinition;
37 import info.magnolia.rendering.template.fragment.FragmentDefinition;
38
39 import java.util.Map;
40
41 /**
42 * Base interface for all renderables. Defines for instance the template's title, template script and render type.
43 */
44 public interface RenderableDefinition extends NamedDefinition {
45
46 String getId();
47
48 // TODO can we PLEASE remove this
49 void setId(String id);
50
51 @Override
52 String getName();
53
54 String getRenderType();
55
56 String getTitle();
57
58 String getDescription();
59
60 String getI18nBasename();
61
62 String getTemplateScript();
63
64 Map<String, RenderableDefinition> getVariations();
65
66 /**
67 * An arbitrary list of parameters. Used to omit subclass with getters and setters for each
68 * extra parameter.
69 */
70 Map<String, Object> getParameters();
71
72 // TODO: use generics again once we get rid of templating-compatibility module
73 Class getModelClass();
74
75 AutoGenerationConfiguration getAutoGeneration();
76
77 Boolean getAutoPopulateFromRequest();
78
79 FragmentDefinition getFragmentDefinition();
80 }