net.officefloor.compile.impl.structure

Class AdministratorNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.AdministratorNodeImpl

All Implemented Interfaces:

AdministratorNode, LinkTeamNode, Node, PropertyConfigurable, OfficeAdministrator

public class AdministratorNodeImpl
extends Object
implements AdministratorNode

AdministratorNode implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.compile.internal.structure.AdministratorNode

TYPE

Constructor Summary

Constructors

Constructor and Description
AdministratorNodeImpl(String administratorName, OfficeNode officeNode, NodeContext context) Initiate.

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value) Adds a Property to configure the item.
void	administerManagedObject(AdministerableManagedObject managedObject) Administers the AdministerableManagedObject.
void	buildAdministrator(OfficeBuilder officeBuilder) Builds this Administrator into the OfficeBuilder.
OfficeDuty	getDuty(String dutyName) Obtains the OfficeDuty.
LinkTeamNode	getLinkedTeamNode() Obtains the LinkTeamNode linked to this LinkTeamNode.
String	getLocation() Obtains the location of the Node.
String	getNodeName() Obtains the name of the Node.
String	getNodeType() Obtains the Node type.
String	getOfficeAdministratorName() Obtains the name of this OfficeAdministrator.
Node	getParentNode() Obtains the Node containing this Node.
void	initialise(String administratorSourceClassName, AdministratorSource<?,?> administratorSource) Initialises this AdministratorNode.
boolean	isInitialised() Indicates if the Node has been initialised.
boolean	linkTeamNode(LinkTeamNode node) Links the input LinkTeamNode to this LinkTeamNode.
AdministratorType<?,?>	loadAdministratorType() Obtains the AdministratorType for this AdministratorNode.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministratorNodeImpl

public AdministratorNodeImpl(String administratorName,
                             OfficeNode officeNode,
                             NodeContext context)

Initiate.

Parameters:

administratorName - Name of this OfficeAdministrator.

officeNode - Parent OfficeNode.

context - NodeContext.

Method Detail

getNodeName

public String getNodeName()

Description copied from interface: Node

Obtains the name of the Node.

Specified by:

getNodeName in interface Node

Returns:

Name of the Node.

getNodeType

public String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public String getLocation()

Description copied from interface: Node

Obtains the location of the Node.

Specified by:

getLocation in interface Node

Returns:

Location of the Node. May be null if Node does not support a location.

getParentNode

public Node getParentNode()

Description copied from interface: Node

Obtains the Node containing this Node.

Specified by:

getParentNode in interface Node

Returns:

Node containing this Node.

isInitialised

public boolean isInitialised()

Description copied from interface: Node

Indicates if the Node has been initialised. Node instances should only be initialised once. Initialising the Node twice is an issue.

Specified by:

isInitialised in interface Node

Returns:

true if initialised.

initialise

public void initialise(String administratorSourceClassName,
                       AdministratorSource<?,?> administratorSource)

Description copied from interface: AdministratorNode

Initialises this AdministratorNode.

Specified by:

initialise in interface AdministratorNode

Parameters:

administratorSourceClassName - Class name of the AdministratorSource.

administratorSource - Optional instantiated AdministratorSource. May be null.

getOfficeAdministratorName

public String getOfficeAdministratorName()

Description copied from interface: OfficeAdministrator

Obtains the name of this OfficeAdministrator.

Specified by:

getOfficeAdministratorName in interface OfficeAdministrator

Returns:

Name of this OfficeAdministrator.

addProperty

public void addProperty(String name,
                        String value)

Description copied from interface: PropertyConfigurable

Adds a Property to configure the item.

Specified by:

addProperty in interface PropertyConfigurable

Parameters:

name - Name of Property.

value - Value of Property.

getDuty

public OfficeDuty getDuty(String dutyName)

Description copied from interface: OfficeAdministrator

Obtains the OfficeDuty.

Specified by:

getDuty in interface OfficeAdministrator

Parameters:

dutyName - Name of the OfficeDuty.

Returns:

OfficeDuty.

administerManagedObject

public void administerManagedObject(AdministerableManagedObject managedObject)

Description copied from interface: OfficeAdministrator

Administers the AdministerableManagedObject.

Specified by:

administerManagedObject in interface OfficeAdministrator

Parameters:

managedObject - AdministerableManagedObject to be administered.

loadAdministratorType

public AdministratorType<?,?> loadAdministratorType()

Description copied from interface: AdministratorNode

Obtains the AdministratorType for this AdministratorNode.

The OfficeAdministrator must be fully populated with the necessary Property instances before calling this.

Specified by:

loadAdministratorType in interface AdministratorNode

Returns:

AdministratorType for this AdministratorNode.

buildAdministrator

public void buildAdministrator(OfficeBuilder officeBuilder)

Description copied from interface: AdministratorNode

Builds this Administrator into the OfficeBuilder.

Specified by:

buildAdministrator in interface AdministratorNode

Parameters:

officeBuilder - OfficeBuilder.

linkTeamNode

public boolean linkTeamNode(LinkTeamNode node)

Description copied from interface: LinkTeamNode

Links the input LinkTeamNode to this LinkTeamNode.

Specified by:

linkTeamNode in interface LinkTeamNode

Parameters:

node - LinkTeamNode to link to this LinkTeamNode.

Returns:

true if linked.

getLinkedTeamNode

public LinkTeamNode getLinkedTeamNode()

Description copied from interface: LinkTeamNode

Obtains the LinkTeamNode linked to this LinkTeamNode.

Specified by:

getLinkedTeamNode in interface LinkTeamNode

Returns:

LinkTeamNode linked to this LinkTeamNode.