Package net.officefloor.frame.impl.construct.administration

Class AdministrationBuilderImpl<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

java.lang.Object

net.officefloor.frame.impl.construct.function.AbstractFunctionBuilder<F>

net.officefloor.frame.impl.construct.administration.AdministrationBuilderImpl<E,F,G>

All Implemented Interfaces:

AdministrationBuilder<F,G>, FunctionBuilder<F>, AdministrationConfiguration<E,F,G>, FunctionConfiguration<F>

public class AdministrationBuilderImpl<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>
extends AbstractFunctionBuilder<F>
implements AdministrationBuilder<F,G>, AdministrationConfiguration<E,F,G>

Implementation of the AdministrationBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
AdministrationBuilderImpl(java.lang.String administrationName, java.lang.Class<E> extensionInterface, AdministrationFactory<E,F,G> administrationFactory)	Initiate.

Method Summary

Modifier and Type	Method	Description
void	administerManagedObject(java.lang.String scopeManagedObjectName)	Flags for the Administration to administer the referenced ManagedObject.
java.lang.String[]	getAdministeredManagedObjectNames()	Obtains the names of the ManagedObject instances to be administered.
AdministrationFactory<E,F,G>	getAdministrationFactory()	Obtains the AdministrationFactory.
java.lang.String	getAdministrationName()	Obtains the name of the Administration.
long	getAsynchronousFlowTimeout()	Obtains the timeout for any AsynchronousFlow instigated.
java.lang.Class<E>	getExtensionType()	Obtains the extension interface.
AdministrationGovernanceConfiguration<?>[]	getGovernanceConfiguration()	Obtains the configuration for the linked Governance.
void	linkGovernance(int governanceIndex, java.lang.String governanceName)	Links a Governance.
void	linkGovernance(G key, java.lang.String governanceName)	Links a Governance.
void	setAsynchronousFlowTimeout(long timeout)	Specifies the timeout to for AsynchronousFlow instances for this Administration.

Methods inherited from class net.officefloor.frame.impl.construct.function.AbstractFunctionBuilder

addEscalation, getEscalations, getFlowConfiguration, getResponsibleTeamName, linkFlow, linkFlow, setResponsibleTeam

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.officefloor.frame.api.build.FunctionBuilder

addEscalation, linkFlow, linkFlow, setResponsibleTeam

Methods inherited from interface net.officefloor.frame.internal.configuration.FunctionConfiguration

getEscalations, getFlowConfiguration, getResponsibleTeamName

Constructor Detail

AdministrationBuilderImpl

public AdministrationBuilderImpl(java.lang.String administrationName,
                                 java.lang.Class<E> extensionInterface,
                                 AdministrationFactory<E,F,G> administrationFactory)

Initiate.

Parameters:

administrationName - Name of the Administration.

extensionInterface - Extension interface.

administrationFactory - AdministrationFactory.

Method Detail

administerManagedObject

public void administerManagedObject(java.lang.String scopeManagedObjectName)

Description copied from interface: AdministrationBuilder

Flags for the Administration to administer the referenced ManagedObject. This may be called more than once to register more than one ManagedObject to be administered by this Administration.

Specified by:

administerManagedObject in interface AdministrationBuilder<E,F extends java.lang.Enum<F>>

Parameters:

scopeManagedObjectName - Name of the ManagedObject within the scope this Administration is being added.

linkGovernance

public void linkGovernance(G key,
                           java.lang.String governanceName)

Description copied from interface: AdministrationBuilder

Links a Governance.

Specified by:

linkGovernance in interface AdministrationBuilder<E,F extends java.lang.Enum<F>>

Parameters:

key - Key to identify the Governance.

governanceName - Name of the Governance.

linkGovernance

public void linkGovernance(int governanceIndex,
                           java.lang.String governanceName)

Description copied from interface: AdministrationBuilder

Links a Governance.

Specified by:

linkGovernance in interface AdministrationBuilder<E,F extends java.lang.Enum<F>>

Parameters:

governanceIndex - Index to identify the Governance.

governanceName - Name of the Governance.

setAsynchronousFlowTimeout

public void setAsynchronousFlowTimeout(long timeout)

Description copied from interface: AdministrationBuilder

Specifies the timeout to for AsynchronousFlow instances for this Administration.

Specified by:

setAsynchronousFlowTimeout in interface AdministrationBuilder<E,F extends java.lang.Enum<F>>

Parameters:

timeout - Timeout.

getAdministrationName

public java.lang.String getAdministrationName()

Description copied from interface: AdministrationConfiguration

Obtains the name of the Administration.

Specified by:

getAdministrationName in interface AdministrationConfiguration<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

Name of the Administration.

getAdministrationFactory

public AdministrationFactory<E,F,G> getAdministrationFactory()

Description copied from interface: AdministrationConfiguration

Obtains the AdministrationFactory.

Specified by:

getAdministrationFactory in interface AdministrationConfiguration<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

AdministrationFactory.

getExtensionType

public java.lang.Class<E> getExtensionType()

Description copied from interface: AdministrationConfiguration

Obtains the extension interface.

Specified by:

getExtensionType in interface AdministrationConfiguration<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

Extension interface.

getGovernanceConfiguration

public AdministrationGovernanceConfiguration<?>[] getGovernanceConfiguration()

Description copied from interface: AdministrationConfiguration

Obtains the configuration for the linked Governance.

Specified by:

getGovernanceConfiguration in interface AdministrationConfiguration<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

AdministrationGovernanceConfiguration specifying the linked Governance.

getAdministeredManagedObjectNames

public java.lang.String[] getAdministeredManagedObjectNames()

Description copied from interface: AdministrationConfiguration

Obtains the names of the ManagedObject instances to be administered.

Specified by:

getAdministeredManagedObjectNames in interface AdministrationConfiguration<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

Names of the ManagedObject instances to be administered.

getAsynchronousFlowTimeout

public long getAsynchronousFlowTimeout()

Description copied from interface: AdministrationConfiguration

Obtains the timeout for any AsynchronousFlow instigated.

Specified by:

getAsynchronousFlowTimeout in interface AdministrationConfiguration<E,F extends java.lang.Enum<F>,G extends java.lang.Enum<G>>

Returns:

Timeout for any AsynchronousFlow instigated.