net.officefloor.web.template.extension.WebTemplateExtensionContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of officeweb_template Show documentation
OfficeFloor Web Template
There is a newer version: 3.40.0
/*-
 * #%L
 * Web Template
 * %%
 * Copyright (C) 2005 - 2020 Daniel Sagenschneider
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 * #L%
 */

package net.officefloor.web.template.extension;

import net.officefloor.compile.spi.section.SectionDependencyObjectNode;
import net.officefloor.compile.spi.section.SectionDesigner;
import net.officefloor.compile.spi.section.SectionFunction;
import net.officefloor.compile.spi.section.SectionManagedObject;
import net.officefloor.compile.spi.section.SectionObject;
import net.officefloor.compile.spi.section.SectionOutput;
import net.officefloor.compile.spi.section.source.SectionSourceContext;
import net.officefloor.frame.api.source.SourceProperties;
import net.officefloor.plugin.section.clazz.loader.ClassSectionFlow;
import net.officefloor.plugin.section.clazz.loader.ClassSectionManagedFunction;
import net.officefloor.server.http.HttpResponse;
import net.officefloor.web.template.build.WebTemplate;

/**
 * Context for the {@link WebTemplateExtension}.
 * 
 * @author Daniel Sagenschneider
 */
public interface WebTemplateExtensionContext extends SourceProperties {

	/**
	 * Obtains the content of the {@link WebTemplate}.
	 * 
	 * @return Content of the {@link WebTemplate}.
	 */
	String getTemplateContent();

	/**
	 * 
	 * Enables overriding the content of the template.
	 * 

	 * This need not be called, however is available should the extension wish to
	 * change the template content.
	 * 
	 * @param templateContent Content of the template.
	 */
	void setTemplateContent(String templateContent);

	/**
	 * Obtains the logic class for the {@link WebTemplate}.
	 * 
	 * @return Logic class for the {@link WebTemplate}.
	 */
	Class getLogicClass();

	/**
	 * Flags that the method on the logic class should not have the template
	 * rendered to the {@link HttpResponse} by default on its completion.
	 * 
	 * @param templateClassMethodName Name of the method on the template class to be
	 *                                flagged to not have template rendered on its
	 *                                completion.
	 */
	void flagAsNonRenderTemplateMethod(String templateClassMethodName);

	/**
	 * 

	 * Obtains the {@link SectionSourceContext} for the {@link WebTemplate} to be
	 * extended.
	 * 
	 * Please be aware that the returned {@link SectionSourceContext} does not
	 * filter the properties. Therefore please use the property methods on this
	 * interface to obtain the extension specific properties.
	 * 
	 * @return {@link SectionSourceContext} for the {@link WebTemplate} to be
	 *         extended.
	 */
	SectionSourceContext getSectionSourceContext();

	/**
	 * Obtains the {@link SectionDesigner} for the {@link WebTemplate} being
	 * extended.
	 * 
	 * @return {@link SectionDesigner} for the {@link WebTemplate} being extended.
	 */
	SectionDesigner getSectionDesigner();

	/**
	 * Obtains the {@link SectionManagedObject} for the template logic object.
	 * 
	 * @return {@link SectionManagedObject}.
	 */
	SectionManagedObject getTemplateLogicObject();

	/**
	 * Obtains the {@link SectionFunction} by the name.
	 * 
	 * @param functionName {@link SectionFunction} name.
	 * @return {@link ClassSectionManagedFunction} or null if no
	 *         {@link SectionFunction} by name.
	 */
	ClassSectionManagedFunction getFunction(String functionName);

	/**
	 * Obtains or creates the {@link SectionObject} for the type name.
	 * 
	 * @param qualifier Qualifier. May be null.
	 * @param typeName  Type name.
	 * @return {@link SectionDependencyObjectNode}.
	 * @throws Exception If fails to obtain dependency.
	 */
	SectionDependencyObjectNode getDependency(String qualifier, String typeName) throws Exception;

	/**
	 * Obtains or creates the {@link SectionOutput}.
	 * 
	 * @param name         {@link SectionOutput} name.
	 * @param argumentType Argument type. May be null if no argument.
	 * @return {@link ClassSectionFlow}.
	 */
	ClassSectionFlow getFlow(String name, String argumentType);

}