net.officefloor.plugin.web.http.template.section

Interface HttpTemplateSectionExtensionContext

All Superinterfaces:

SourceProperties

public interface HttpTemplateSectionExtensionContext
extends SourceProperties

Context for the HttpTemplateSectionExtension.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	flagAsNonRenderTemplateMethod(String templateClassMethodName) Flags that the method on the template class should not have the template rendered to the HttpResponse by default on its completion.
SectionObject	getOrCreateSectionObject(String typeName) Obtains or creates the SectionObject for the type name.
SectionOutput	getOrCreateSectionOutput(String name, String argumentType, boolean isEscalationOnly) Obtains or creates the SectionOutput.
SectionDesigner	getSectionDesigner() Obtains the SectionDesigner for the HttpTemplateSectionSource being extended.
SectionSourceContext	getSectionSourceContext() Obtains the SectionSourceContext for the HttpTemplateSectionSource to be extended.
SectionTask	getTask(String taskName) Obtains the SectionTask by the name.
Class<?>	getTemplateClass() Obtains the logic class for the template.
String	getTemplateContent() Obtains the content of the template.
SectionManagedObject	getTemplateLogicObject() Obtains the SectionManagedObject for the template logic object.
void	setTemplateContent(String templateContent) Enables overriding the content of the template.

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

getProperties, getProperty, getProperty, getPropertyNames

Method Detail

getTemplateContent

String getTemplateContent()

Obtains the content of the template.

Returns:

Content of the template.

setTemplateContent

void setTemplateContent(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.

getTemplateClass

Class<?> getTemplateClass()

Obtains the logic class for the template.

Returns:

Logic class for the template.

flagAsNonRenderTemplateMethod

void flagAsNonRenderTemplateMethod(String templateClassMethodName)

Flags that the method on the template 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 HttpTemplateSectionSource 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 HttpTemplateSectionSource to be extended.

getSectionDesigner

SectionDesigner getSectionDesigner()

Obtains the SectionDesigner for the HttpTemplateSectionSource being extended.

Returns:

SectionDesigner for the HttpTemplateSectionSource being extended.

getTemplateLogicObject

SectionManagedObject getTemplateLogicObject()

Obtains the SectionManagedObject for the template logic object.

Returns:

SectionManagedObject.

getTask

SectionTask getTask(String taskName)

Obtains the SectionTask by the name.

Parameters:

taskName - SectionTask name.

Returns:

SectionTask or null if no SectionTask by name.

getOrCreateSectionObject

SectionObject getOrCreateSectionObject(String typeName)

Obtains or creates the SectionObject for the type name.

Parameters:

typeName - Type name.

Returns:

SectionObject.

getOrCreateSectionOutput

SectionOutput getOrCreateSectionOutput(String name,
                                       String argumentType,
                                       boolean isEscalationOnly)

Obtains or creates the SectionOutput.

Parameters:

name - SectionOutput name.

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

isEscalationOnly - true if escalation only.

Returns:

SectionOutput.