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.model;
35
36 import info.magnolia.rendering.template.RenderableDefinition;
37
38 /**
39 * Implemented by models that want to handle early execution in a separate callback. Also adds a setter for the parent
40 * model. It is called after early execution and before rendering.
41 *
42 * @param <RD> a type implementing {@link RenderableDefinition}
43 * @see RenderingModel
44 * @see ModelExecutionFilter
45 */
46 public interface EarlyExecutionAware<RD extends RenderableDefinition> extends RenderingModel<RD> {
47
48 /**
49 * Called before rendering of the component.
50 */
51 void setParent(RenderingModel parentModel);
52
53 /**
54 * Called after all properties were set. Can return a string which is passed
55 * to the method.
56 * {@link RenderableDefinition#determineTemplatePath(String, RenderingModel)}
57 */
58 String executeEarly();
59 }