|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RenderableDefinition | Line # 47 | 0 | - | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
No Tests | |||
1 | /** | |
2 | * This file Copyright (c) 2008-2011 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.module.templating; | |
35 | ||
36 | import java.lang.reflect.InvocationTargetException; | |
37 | import java.util.Map; | |
38 | ||
39 | import info.magnolia.cms.core.Content; | |
40 | ||
41 | /** | |
42 | * Abstract rendering definition used for templates and paragraphs. | |
43 | * @author pbracher | |
44 | * @version $Id: RenderableDefinition.java 41137 2011-01-06 18:19:25Z gjoseph $ | |
45 | * | |
46 | */ | |
47 | public interface RenderableDefinition { | |
48 | public String getName(); | |
49 | public String getType(); | |
50 | public String getTitle(); | |
51 | public String getDescription(); | |
52 | public String getI18nBasename(); | |
53 | public String getTemplatePath(); | |
54 | public String getDialog(); | |
55 | ||
56 | /** | |
57 | * An arbitrary list of parameters. Used to omit subclass with getters and setters for each extra parameter. | |
58 | */ | |
59 | public Map getParameters(); | |
60 | ||
61 | /** | |
62 | * Create the model based on the current content. | |
63 | */ | |
64 | public RenderingModel newModel(Content content, RenderableDefinition definition, RenderingModel parentModel) throws IllegalArgumentException, InstantiationException, IllegalAccessException, InvocationTargetException; | |
65 | ||
66 | /** | |
67 | * The modules execute() method can return a string which is passed to this method to determine the template to use. | |
68 | */ | |
69 | public String determineTemplatePath(String actionResult, RenderingModel model); | |
70 | } |
|