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 java.util.Map;
37
38
39 /**
40 * A {@link RenderableDefinition} which supports editing in the page editor and can define their areas.
41 *
42 * <p>Provides additional information such as template type and subtype which can be used for
43 * {@link info.magnolia.rendering.template.TemplateAvailability}. Default template types are provided in
44 * {@link info.magnolia.rendering.template.type.DefaultTemplateTypes}.</p>
45 */
46 public interface TemplateDefinition extends RenderableDefinition {
47
48 Boolean getVisible();
49
50 String getDialog();
51
52 Map<String, AreaDefinition> getAreas();
53
54 TemplateAvailability getTemplateAvailability();
55
56 /**
57 * Specifies the template type, e.g. "home", "section", etc.
58 */
59 String getType();
60
61 /**
62 * Specifies the template subtype, such as specific features, e.g. "news", etc.
63 */
64 String getSubtype();
65
66 Boolean getEditable();
67
68 Boolean getMoveable();
69
70 Boolean getDeletable();
71
72 Boolean getWritable();
73 }