Package net.officefloor.woof.template

Interface WoofTemplateExtensionSource

All Known Implementing Classes:

AbstractWoofTemplateExtensionSource

public interface WoofTemplateExtensionSource

Source that allows extending behaviour of a WebTemplate.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
Change<?>	createConfigurationChange(WoofTemplateExtensionChangeContext context)	This is only invoked by the WoOF editor to enable managing configuration for the WoofTemplateExtensionSource.
void	extendTemplate(WoofTemplateExtensionSourceContext context)	Extends the WebTemplate.
WoofTemplateExtensionSourceSpecification	getSpecification()	Obtains the specification for this.

Method Details

getSpecification

WoofTemplateExtensionSourceSpecification getSpecification()

Obtains the specification for this.

This will be called before any other methods, therefore this method must be able to return the specification immediately after a default constructor instantiation.

Returns:

Specification of this.

createConfigurationChange

Change<?> createConfigurationChange(WoofTemplateExtensionChangeContext context)

This is only invoked by the WoOF editor to enable managing configuration for the WoofTemplateExtensionSource. It is not used during extension of the WebTemplate.

This method is to create a potential Change to the configuration necessary for the WoofTemplateExtensionSource. Should no Change be required it should return null.

WoofTemplateExtensionSource implementations may require configuration by extra files within the application. This method allows the WoofTemplateExtensionSource to create/update/delete the files within the ConfigurationContext (i.e. Java raw source project).

Note that all actions must be undertaken by the returned Change as this method may be invoked to validate configuration. This is to avoid side effects by the WoOF editor.

Should configuration of the WoofTemplateExtensionSource be invalid, this method should return a Change with a Conflict instance explaining the reason the configuration is invalid.

Parameters:

context - WoofTemplateExtensionChangeContext.

Returns:

Change or null if no change is necessary.

extendTemplate

void extendTemplate(WoofTemplateExtensionSourceContext context)
             throws Exception

Extends the WebTemplate.

Parameters:

context - WoofTemplateExtensionSourceContext.

Throws:

Exception - If fails to extend the WebTemplate.