net.officefloor.compile.spi.governance.source
Interface GovernanceSource<I,F extends Enum<F>>

All Known Implementing Classes:

AbstractGovernanceSource, ClassGovernanceSource, JpaTransactionGovernanceSource

public interface GovernanceSource<I,F extends Enum<F>>

Source to obtain the Governance.

Author:

Daniel Sagenschneider

Method Summary

GovernanceSourceMetaData<I,F>	getMetaData() Obtains the meta-data to describe this.
GovernanceSourceSpecification	getSpecification() Obtains the specification for this.
void	init(GovernanceSourceContext context) Called only once after the GovernanceSource is instantiated.

Method Detail

getSpecification

GovernanceSourceSpecification 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

void init(GovernanceSourceContext context)
          throws Exception

Called only once after the GovernanceSource is instantiated.

Parameters:

context - GovernanceSourceContext to initialise this instance of the GovernanceSource.

Throws:

Exception - Should the GovernanceSource fail to configure itself from the input properties.

getMetaData

GovernanceSourceMetaData<I,F> getMetaData()

Obtains the meta-data to describe this.

This is called after the init(GovernanceSourceContext) method and therefore may use the configuration.

This should always return non-null. If there is a problem due to incorrect configuration, the init(GovernanceSourceContext) method should indicate this via an exception.

Returns:

Meta-data to describe this.