Package net.officefloor.web.template.extension

Interface WebTemplateExtensionContext

All Superinterfaces:

SourceProperties

public interface WebTemplateExtensionContext
extends SourceProperties

Context for the WebTemplateExtension.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	flagAsNonRenderTemplateMethod(java.lang.String templateClassMethodName)	Flags that the method on the logic class should not have the template rendered to the HttpResponse by default on its completion.
SectionDependencyObjectNode	getDependency(java.lang.String qualifier, java.lang.String typeName)	Obtains or creates the SectionObject for the type name.
ClassSectionFlow	getFlow(java.lang.String name, java.lang.String argumentType)	Obtains or creates the SectionOutput.
ClassSectionManagedFunction	getFunction(java.lang.String functionName)	Obtains the SectionFunction by the name.
java.lang.Class<?>	getLogicClass()	Obtains the logic class for the WebTemplate.
SectionDesigner	getSectionDesigner()	Obtains the SectionDesigner for the WebTemplate being extended.
SectionSourceContext	getSectionSourceContext()	Obtains the SectionSourceContext for the WebTemplate to be extended.
java.lang.String	getTemplateContent()	Obtains the content of the WebTemplate.
SectionManagedObject	getTemplateLogicObject()	Obtains the SectionManagedObject for the template logic object.
void	setTemplateContent(java.lang.String templateContent)	Enables overriding the content of the template.

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

getTemplateContent

java.lang.String getTemplateContent()

Obtains the content of the WebTemplate.

Returns:

Content of the WebTemplate.

setTemplateContent

void setTemplateContent(java.lang.String templateContent)

Enables overriding the content of the template.

This need not be called, however is available should the extension wish to change the template content.

Parameters:

templateContent - Content of the template.

getLogicClass

java.lang.Class<?> getLogicClass()

Obtains the logic class for the WebTemplate.

Returns:

Logic class for the WebTemplate.

flagAsNonRenderTemplateMethod

void flagAsNonRenderTemplateMethod(java.lang.String templateClassMethodName)

Flags that the method on the logic class should not have the template rendered to the HttpResponse by default on its completion.

Parameters:

templateClassMethodName - Name of the method on the template class to be flagged to not have template rendered on its completion.

getSectionSourceContext

SectionSourceContext getSectionSourceContext()

Obtains the SectionSourceContext for the WebTemplate to be extended.

Please be aware that the returned SectionSourceContext does not filter the properties. Therefore please use the property methods on this interface to obtain the extension specific properties.

Returns:

SectionSourceContext for the WebTemplate to be extended.

getSectionDesigner

SectionDesigner getSectionDesigner()

Obtains the SectionDesigner for the WebTemplate being extended.

Returns:

SectionDesigner for the WebTemplate being extended.

getTemplateLogicObject

SectionManagedObject getTemplateLogicObject()

Obtains the SectionManagedObject for the template logic object.

Returns:

SectionManagedObject.

getFunction

ClassSectionManagedFunction getFunction(java.lang.String functionName)

Obtains the SectionFunction by the name.

Parameters:

functionName - SectionFunction name.

Returns:

ClassSectionManagedFunction or null if no SectionFunction by name.

getDependency

SectionDependencyObjectNode getDependency(java.lang.String qualifier,
                                          java.lang.String typeName)
                                   throws java.lang.Exception

Obtains or creates the SectionObject for the type name.

Parameters:

qualifier - Qualifier. May be null.

typeName - Type name.

Returns:

SectionDependencyObjectNode.

Throws:

java.lang.Exception - If fails to obtain dependency.

getFlow

ClassSectionFlow getFlow(java.lang.String name,
                         java.lang.String argumentType)

Obtains or creates the SectionOutput.

Parameters:

name - SectionOutput name.

argumentType - Argument type. May be null if no argument.

Returns:

ClassSectionFlow.