Package net.officefloor.compile.spi.administration.source

Interface AdministrationSource<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

All Known Implementing Classes:

AbstractAdministrationSource, ClassAdministrationSource, HttpAccessAdministrationSource

public interface AdministrationSource<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Source to obtain a particular type of Administration.

Implemented by the Administration provider.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
AdministrationSourceSpecification	getSpecification()	Obtains the specification for this.
AdministrationSourceMetaData<E,F,G>	init(AdministrationSourceContext context)	Initialises the AdministrationSource.

Method Detail

getSpecification

AdministrationSourceSpecification 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.

init

AdministrationSourceMetaData<E,F,G> init(AdministrationSourceContext context)
                                              throws java.lang.Exception

Initialises the AdministrationSource.

Parameters:

context - AdministrationSourceContext to initialise this instance of the AdministrationSource.

Returns:

Meta-data to describe this.

Throws:

java.lang.Exception - Should the AdministrationSource fail to configure itself from the input properties.