net.officefloor.frame.impl.construct.administrator

Class AdministratorBuilderImpl<I,A extends Enum<A>,AS extends AdministratorSource<I,A>>

java.lang.Object

net.officefloor.frame.impl.construct.administrator.AdministratorBuilderImpl<I,A,AS>

All Implemented Interfaces:

AdministratorBuilder<A>, AdministratorSourceConfiguration<A,AS>

public class AdministratorBuilderImpl<I,A extends Enum<A>,AS extends AdministratorSource<I,A>>
extends Object
implements AdministratorBuilder<A>, AdministratorSourceConfiguration<A,AS>

Implementation of the AdministratorBuilder.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
AdministratorBuilderImpl(String administratorName, Class<AS> administratorSourceClass) Initiate.

Method Summary

Modifier and Type	Method and Description
DutyBuilder	addDuty(String dutyName) Adds a Duty of the Administrator.
void	addProperty(String name, String value) Specifies a property for the AdministratorSource.
void	administerManagedObject(String scopeManagedObjectName) Flags for the Administrator to administer the referenced ManagedObject.
String[]	getAdministeredManagedObjectNames() Obtains the names of the ManagedObject instances to be administered.
String	getAdministratorName() Obtains the name of the AdministratorSource.
Class<AS>	getAdministratorSourceClass() Obtains the Class of the AdministratorSource.
DutyConfiguration<A>[]	getDutyConfiguration() Obtains the listing of DutyConfiguration for the Duty instances of this Administrator.
String	getOfficeTeamName() Obtains the name of the Team within the Office responsible for completing the Duty instances of this Administrator.
SourceProperties	getProperties() Obtains the SourceProperties to initialise the AdministratorSource.
void	setTeam(String officeTeamName) Name of the Team linked to the Office of this Administrator which is responsible for doing to the Duty instances of this Administrator.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministratorBuilderImpl

public AdministratorBuilderImpl(String administratorName,
                                Class<AS> administratorSourceClass)

Initiate.

Parameters:

administratorName - Name of the Administrator.

administratorSourceClass - Class of the AdministratorSource.

Method Detail

addProperty

public void addProperty(String name,
                        String value)

Description copied from interface: AdministratorBuilder

Specifies a property for the AdministratorSource.

Specified by:

addProperty in interface AdministratorBuilder<A extends Enum<A>>

Parameters:

name - Name of property.

value - Value of property.

setTeam

public void setTeam(String officeTeamName)

Description copied from interface: AdministratorBuilder

Name of the Team linked to the Office of this Administrator which is responsible for doing to the Duty instances of this Administrator.

Specified by:

setTeam in interface AdministratorBuilder<A extends Enum<A>>

Parameters:

officeTeamName - Name of Team within the Office for this Administrator.

administerManagedObject

public void administerManagedObject(String scopeManagedObjectName)

Description copied from interface: AdministratorBuilder

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

Specified by:

administerManagedObject in interface AdministratorBuilder<A extends Enum<A>>

Parameters:

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

addDuty

public DutyBuilder addDuty(String dutyName)

Description copied from interface: AdministratorBuilder

Adds a Duty of the Administrator.

Specified by:

addDuty in interface AdministratorBuilder<A extends Enum<A>>

Parameters:

dutyName - Name identifying the Duty.

Returns:

DutyBuilder for the specified Duty.

getAdministratorName

public String getAdministratorName()

Description copied from interface: AdministratorSourceConfiguration

Obtains the name of the AdministratorSource.

Specified by:

getAdministratorName in interface AdministratorSourceConfiguration<A extends Enum<A>,AS extends AdministratorSource<I,A>>

Returns:

Name of the AdministratorSource.

getAdministratorSourceClass

public Class<AS> getAdministratorSourceClass()

Description copied from interface: AdministratorSourceConfiguration

Obtains the Class of the AdministratorSource.

Specified by:

getAdministratorSourceClass in interface AdministratorSourceConfiguration<A extends Enum<A>,AS extends AdministratorSource<I,A>>

Returns:

Class of the AdministratorSource.

getProperties

public SourceProperties getProperties()

Description copied from interface: AdministratorSourceConfiguration

Obtains the SourceProperties to initialise the AdministratorSource.

Specified by:

getProperties in interface AdministratorSourceConfiguration<A extends Enum<A>,AS extends AdministratorSource<I,A>>

Returns:

SourceProperties to initialise the AdministratorSource.

getOfficeTeamName

public String getOfficeTeamName()

Description copied from interface: AdministratorSourceConfiguration

Obtains the name of the Team within the Office responsible for completing the Duty instances of this Administrator.

Specified by:

getOfficeTeamName in interface AdministratorSourceConfiguration<A extends Enum<A>,AS extends AdministratorSource<I,A>>

Returns:

Office name of the Team.

getAdministeredManagedObjectNames

public String[] getAdministeredManagedObjectNames()

Description copied from interface: AdministratorSourceConfiguration

Obtains the names of the ManagedObject instances to be administered.

Specified by:

getAdministeredManagedObjectNames in interface AdministratorSourceConfiguration<A extends Enum<A>,AS extends AdministratorSource<I,A>>

Returns:

Names of the ManagedObject instances to be administered.

getDutyConfiguration

public DutyConfiguration<A>[] getDutyConfiguration()

Description copied from interface: AdministratorSourceConfiguration

Obtains the listing of DutyConfiguration for the Duty instances of this Administrator.

Specified by:

getDutyConfiguration in interface AdministratorSourceConfiguration<A extends Enum<A>,AS extends AdministratorSource<I,A>>

Returns:

Listing of DutyConfiguration for the Duty instances of this Administrator.