1 /**
2 * This file Copyright (c) 2011-2018 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.i18nsystem.I18nText;
38 import info.magnolia.i18nsystem.I18nable;
39 import info.magnolia.rendering.template.fragment.FragmentDefinition;
40 import info.magnolia.rendering.template.i18n.RenderableDefinitionKeyGenerator;
41
42 import java.util.Map;
43
44 /**
45 * Base interface for all renderables. Defines for instance the template's title, template script and render type.
46 */
47 @I18nable(keyGenerator = RenderableDefinitionKeyGenerator.class)
48 public interface RenderableDefinition extends NamedDefinition {
49
50 String getId();
51
52 // TODO can we PLEASE remove this
53 void setId(String id);
54
55 @Override
56 String getName();
57
58 String getRenderType();
59
60 @I18nText
61 String getTitle();
62
63 @I18nText
64 String getDescription();
65
66 /**
67 * This is support for old I18n mechanism where you need to provide keys {@link #getTitle()} and {@link #getDescription()}.
68 * The new i18n mechanism generates the keys via {@link RenderableDefinitionKeyGenerator} automatically.
69 *
70 * @deprecated since 5.4.4. I18nBasename is deprecated and will be removed in a future version.
71 */
72 @Deprecated
73 String getI18nBasename();
74
75 String getTemplateScript();
76
77 Map<String, RenderableDefinition> getVariations();
78
79 /**
80 * An arbitrary list of parameters. Used to omit subclass with getters and setters for each
81 * extra parameter.
82 */
83 Map<String, Object> getParameters();
84
85 // TODO: use generics again once we get rid of templating-compatibility module
86 Class getModelClass();
87
88 AutoGenerationConfiguration getAutoGeneration();
89
90 Boolean getAutoPopulateFromRequest();
91
92 FragmentDefinition getFragmentDefinition();
93 }