Package net.officefloor.frame.internal.structure

Interface GovernanceContainer<E>

All Known Implementing Classes:

GovernanceContainerImpl

public interface GovernanceContainer<E>

Container managing the Governance.

Governance may only reside on the single ThreadState requiring the Governance.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
BlockState	activateGovernance()	Activates the Governance.
FunctionState	deactivateGovernance()	Deactivates the Governance.
BlockState	disregardGovernance()	Disregards the Governance.
BlockState	enforceGovernance()	Enforces the Governance.
boolean	isGovernanceActive()	Indicates if Governance within this GovernanceContainer is active.
<O extends Enum<O>> RegisteredGovernance	registerManagedObject(E managedObjectExtension, ManagedObjectContainer managedObjectContainer, ManagedObjectMetaData<O> managedObjectMetaData, ManagedFunctionContainer managedFunctionContainer)	Registers the ManagedObject for Governance.

Method Details

isGovernanceActive

boolean isGovernanceActive()

Indicates if Governance within this GovernanceContainer is active.

Returns:

true if the Governance is active.

registerManagedObject

<O extends Enum<O>> RegisteredGovernance registerManagedObject(E managedObjectExtension,
 ManagedObjectContainer managedObjectContainer,
 ManagedObjectMetaData<O> managedObjectMetaData,
 ManagedFunctionContainer managedFunctionContainer)

Registers the ManagedObject for Governance.

Type Parameters:

O - Object type.

Parameters:

managedObjectExtension - Extension of the ManagedObject to enable Governance.

managedObjectContainer - ManagedObjectContainer for the ManagedObject.

managedObjectMetaData - ManagedObjectMetaData for the ManagedObject.

managedFunctionContainer - ManagedFunctionContainer to enable access to ManagedFunctionContainer bound dependencies.

Returns:

RegisteredGovernance.

activateGovernance

BlockState activateGovernance()

Activates the Governance. This will co-ordinate the Governance over the ManagedObject instances.

Returns:

BlockState to activate the Governance.

enforceGovernance

BlockState enforceGovernance()

Enforces the Governance.

Returns:

BlockState to enforce the Governance.

disregardGovernance

BlockState disregardGovernance()

Disregards the Governance.

Returns:

BlockState to disregard the Governance.

deactivateGovernance

FunctionState deactivateGovernance()

Deactivates the Governance. This will release the ManagedObject instances from Governance.

Returns:

Deactivate the Governance.