Package net.officefloor.compile.impl.structure

Class OfficeNodeImpl

java.lang.Object

net.officefloor.compile.impl.structure.OfficeNodeImpl

All Implemented Interfaces:

LinkOfficeNode, ManagedFunctionVisitor, ManagedObjectRegistry, Node, OfficeNode, OfficeTeamRegistry, OverrideProperties, SourceIssues, PropertyConfigurable, OfficeArchitect, DeployedOffice

public class OfficeNodeImpl
extends java.lang.Object
implements OfficeNode, ManagedFunctionVisitor

OfficeNode implementation.

Author:

Daniel Sagenschneider

Field Summary

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

TYPE

Constructor Summary

Constructors

Constructor	Description
OfficeNodeImpl(java.lang.String officeName, OfficeFloorNode officeFloor, NodeContext context)	Initialise with all parameters.

Method Summary

Modifier and Type	Method	Description
void	addAdditionalProfile(java.lang.String profile)	Adds an additional profile specific to the DeployedOffice.
CompileError	addIssue(java.lang.String issueDescription)	Allows the source to add an issue.
CompileError	addIssue(java.lang.String issueDescription, java.lang.Throwable cause)	Allows the source to add an issue along with its cause.
void	addManagedFunctionAugmentor(ManagedFunctionAugmentor managedFunctionAugmentor)	Adds a ManagedFunctionAugmentor.
ManagedObjectNode	addManagedObjectNode(java.lang.String managedObjectName, ManagedObjectScope managedObjectScope, ManagedObjectSourceNode managedObjectSourceNode)	Adds an initialised ManagedObjectNode to the registry.
OfficeManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, java.lang.String managedObjectPoolSourceClassName)	Adds an OfficeManagedObjectPool.
OfficeManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds an OfficeManagedObjectPool.
OfficeManagedObjectSource	addManagedObjectSource(java.lang.String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject)	Adds a OfficeManagedObjectSource supplied from an OfficeSupplier.
OfficeAdministration	addOfficeAdministration(java.lang.String administrationName, java.lang.String administrationSourceClassName)	Adds an OfficeAdministration.
OfficeAdministration	addOfficeAdministration(java.lang.String administrationName, AdministrationSource<?,?,?> administrationSource)	Adds an OfficeAdministration.
void	addOfficeCompletionExplorer(CompletionExplorer completionExplorer)	Adds a CompletionExplorer to be notified of completion of exploring the execution tree.
OfficeEscalation	addOfficeEscalation(java.lang.String escalationTypeName)	Adds an OfficeEscalation.
void	addOfficeEscalationExplorer(EscalationExplorer escalationExplorer)	Adds an EscalationExplorer for the execution tree from the added OfficeEscalation instances.
OfficeGovernance	addOfficeGovernance(java.lang.String governanceName, java.lang.String governanceSourceClassName)	Adds a OfficeGovernance.
OfficeGovernance	addOfficeGovernance(java.lang.String governanceName, GovernanceSource<?,?> governanceSource)	Adds an OfficeGovernance.
OfficeInput	addOfficeInput(java.lang.String inputName, java.lang.String parameterType)	Adds a OfficeInput.
OfficeManagedObjectSource	addOfficeManagedObjectSource(java.lang.String managedObjectSourceName, java.lang.String managedObjectSourceClassName)	Adds a OfficeManagedObjectSource.
OfficeManagedObjectSource	addOfficeManagedObjectSource(java.lang.String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource)	Adds a OfficeManagedObjectSource.
OfficeObject	addOfficeObject(java.lang.String officeManagedObjectName, java.lang.String objectType)	Adds an OfficeObject.
OfficeOutput	addOfficeOutput(java.lang.String outputName, java.lang.String argumentType)	Adds a OfficeOutput.
OfficeSection	addOfficeSection(java.lang.String sectionName, java.lang.String sectionSourceClassName, java.lang.String sectionLocation)	Adds an OfficeSection.
OfficeSection	addOfficeSection(java.lang.String sectionName, SectionSource sectionSource, java.lang.String sectionLocation)	Adds an OfficeSection.
void	addOfficeSectionTransformer(OfficeSectionTransformer transformer)	Adds an OfficeSectionTransformer to transform the OfficeSection instances of the Office.
OfficeStart	addOfficeStart(java.lang.String startName)	Adds an OfficeStart.
OfficeTeam	addOfficeTeam(java.lang.String officeTeamName)	Adds an OfficeTeam.
void	addOverrideProperty(java.lang.String name, java.lang.String value)	Adds an override Property.
void	addProperty(java.lang.String name, java.lang.String value)	Adds a Property to configure the item.
OfficeSupplier	addSupplier(java.lang.String supplierName, java.lang.String supplierSourceClassName)	Adds an OfficeSupplier.
OfficeSupplier	addSupplier(java.lang.String supplierName, SupplierSource supplierSource)	Adds an OfficeSupplier.
void	autoWireObjects(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext)	Auto-wires the OfficeObjectNode instances that are unlinked.
void	autoWireTeams(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext)	Auto-wires the OfficeTeamNode instances that are unlinked.
OfficeBindings	buildOffice(OfficeFloorBuilder builder, CompileContext compileContext, Profiler profiler)	Builds the Office for this OfficeNode.
OfficeTeamNode	createOfficeTeam(java.lang.String officeTeamName)	Creates the OfficeTeamNode.
void	enableAutoWireObjects()	Flags to attempt to auto wire any non-configured object links.
void	enableAutoWireTeams()	Flags to attempt to auto wire any non-configured Team links.
java.lang.String[]	getAdditionalProfiles()	Obtains the additional profiles.
AvailableType[]	getAvailableTypes(CompileContext compileContext)	Obtains the AvailableType instances.
Node[]	getChildNodes()	Obtains the child Node instances.
DeployedOfficeInput	getDeployedOfficeInput(java.lang.String sectionName, java.lang.String inputName)	Obtains the DeployedOfficeInput for the OfficeAvailableSectionInputType.
java.lang.String	getDeployedOfficeName()	Obtains the name of this DeployedOffice.
OfficeObject	getDeployedOfficeObject(java.lang.String officeManagedObjectName)	Obtains the OfficeObject for the OfficeManagedObjectType.
OfficeTeam	getDeployedOfficeTeam(java.lang.String officeTeamName)	Obtains the OfficeTeam for the OfficeTeamType.
InternalSupplier[]	getInternalSuppliers()	Obtains the InternalSupplier instances for the Office.
LinkOfficeNode	getLinkedOfficeNode()	Obtains the LinkOfficeNode linked to this LinkOfficeNode.
java.lang.String	getLocation()	Obtains the location of the Node.
ManagedObjectNode	getManagedObjectNode(java.lang.String managedObjectName)	Obtains the ManagedObjectNode from the registry.
java.lang.String	getNodeName()	Obtains the name of the Node.
java.lang.String	getNodeType()	Obtains the Node type.
OfficeFloorNode	getOfficeFloorNode()	Obtains the OfficeFloorNode containing this OfficeNode.
OfficeSection	getOfficeSection(java.lang.String sectionName)	Obtains the OfficeSection.
OfficeTeamNode[]	getOfficeTeams()	Obtains the OfficeTeamNode instances.
PropertyList	getOverridePropertyList()	Obtains the override PropertyList.
Node	getParentNode()	Obtains the Node containing this Node.
void	initialise(java.lang.String officeSourceClassName, OfficeSource officeSource, java.lang.String officeLocation)	Initialises the OfficeNode.
boolean	isInitialised()	Indicates if the Node has been initialised.
void	link(OfficeDependencyRequireNode dependencyRequiredNode, OfficeDependencyObjectNode dependencyObjectNode)	Links the OfficeDependencyRequireNode to be fulfilled by the OfficeDependencyObjectNode.
void	link(OfficeFlowSourceNode flowSourceNode, OfficeFlowSinkNode flowSinkNode)	Links the OfficeFlowSourceNode to be undertaken by the OfficeFlowSinkNode.
void	link(OfficeManagedObjectSource managedObjectSource, OfficeManagedObjectPool managedObjectPool)	Links the OfficeManagedObjectSource to be pooled by the OfficeManagedObjectPool.
void	link(OfficeResponsibility responsibility, OfficeTeam officeTeam)	Links the OfficeResponsibility to the OfficeTeam.
boolean	linkOfficeNode(LinkOfficeNode node)	Links the input LinkOfficeNode to this LinkOfficeNode.
void	loadExternalServicing(Office office)	Loads the FunctionManager instances to externally trigger this OfficeNode.
OfficeType	loadOfficeType(CompileContext compileContext)	Loads the OfficeType.
boolean	runExecutionExplorers(CompileContext compileContext)	Runs the ExecutionExplorer instances.
boolean	sourceOfficeTree(ManagedObjectSourceVisitor managedObjectSourceVisitor, AutoWirerVisitor autoWirerVisitor, CompileContext compileContext)	Sources this Office and all descendant Node instances.
boolean	sourceOfficeWithTopLevelSections(ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext)	Sources this Office along with its top level OfficeSection instances into this OfficeNode.
void	startAfter(OfficeManagedObjectSource managedObjectSource, java.lang.String managedObjectTypeName)	Flags an OfficeManagedObjectSource to be started after ManagedObjectSource instances providing the type.
void	startAfter(OfficeManagedObjectSource startLater, OfficeManagedObjectSource startEarlier)	Flags an OfficeManagedObjectSource to be started after another OfficeManagedObjectSource.
void	startBefore(OfficeManagedObjectSource managedObjectSource, java.lang.String managedObjectTypeName)	Flags an OfficeManagedObjectSource to be started before ManagedObjectSource instances providing the type.
void	startBefore(OfficeManagedObjectSource startEarlier, OfficeManagedObjectSource startLater)	Flags an OfficeManagedObjectSource to be started before another OfficeManagedObjectSource.
void	visit(ManagedFunctionType<?,?> managedFunctionType, ManagedFunctionNode managedFunctionNode, CompileContext compileContext)	Visits the ManagedFunctionNode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.compile.internal.structure.Node

getQualifiedName, getQualifiedName

Constructor Detail

OfficeNodeImpl

public OfficeNodeImpl(java.lang.String officeName,
                      OfficeFloorNode officeFloor,
                      NodeContext context)

Initialise with all parameters.

Parameters:

officeName - Name of the DeployedOffice.

officeFloor - Parent OfficeFloorNode.

context - NodeContext.

Method Detail

getNodeName

public java.lang.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 java.lang.String getNodeType()

Description copied from interface: Node

Obtains the Node type.

Specified by:

getNodeType in interface Node

Returns:

Node type.

getLocation

public java.lang.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.

getChildNodes

public Node[] getChildNodes()

Description copied from interface: Node

Obtains the child Node instances.

Specified by:

getChildNodes in interface Node

Returns:

Child Node instances.

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(java.lang.String officeSourceClassName,
                       OfficeSource officeSource,
                       java.lang.String officeLocation)

Description copied from interface: OfficeNode

Initialises the OfficeNode.

Specified by:

initialise in interface OfficeNode

Parameters:

officeSourceClassName - OfficeSource class name.

officeSource - Optional instantiated OfficeSource. May be null.

officeLocation - Location of the Office.

getManagedObjectNode

public ManagedObjectNode getManagedObjectNode(java.lang.String managedObjectName)

Description copied from interface: ManagedObjectRegistry

Obtains the ManagedObjectNode from the registry.

The returned ManagedObjectNode may or may not be initialised.

Specified by:

getManagedObjectNode in interface ManagedObjectRegistry

Parameters:

managedObjectName - Name of the ManagedObjectNode.

Returns:

ManagedObjectNode from the registry.

addManagedObjectNode

public ManagedObjectNode addManagedObjectNode(java.lang.String managedObjectName,
                                              ManagedObjectScope managedObjectScope,
                                              ManagedObjectSourceNode managedObjectSourceNode)

Description copied from interface: ManagedObjectRegistry

Adds an initialised ManagedObjectNode to the registry.

Should an ManagedObjectNode already be added by the name, then an issue is reported to the CompilerIssue.

Specified by:

addManagedObjectNode in interface ManagedObjectRegistry

Parameters:

managedObjectName - Name of the ManagedObjectNode.

managedObjectScope - ManagedObjectScope.

managedObjectSourceNode - ManagedObjectSourceNode for the ManagedObjectNode.

Returns:

Initialised ManagedObjectNode by the name.

getOfficeTeams

public OfficeTeamNode[] getOfficeTeams()

Description copied from interface: OfficeTeamRegistry

Obtains the OfficeTeamNode instances.

Specified by:

getOfficeTeams in interface OfficeTeamRegistry

Returns:

OfficeTeamNode instances.

createOfficeTeam

public OfficeTeamNode createOfficeTeam(java.lang.String officeTeamName)

Description copied from interface: OfficeTeamRegistry

Creates the OfficeTeamNode.

The name of the OfficeTeamNode may be adjusted to ensure uniqueness.

Specified by:

createOfficeTeam in interface OfficeTeamRegistry

Parameters:

officeTeamName - OfficeTeam name.

Returns:

OfficeTeamNode.

visit

public void visit(ManagedFunctionType<?,?> managedFunctionType,
                  ManagedFunctionNode managedFunctionNode,
                  CompileContext compileContext)

Description copied from interface: ManagedFunctionVisitor

Visits the ManagedFunctionNode.

Specified by:

visit in interface ManagedFunctionVisitor

Parameters:

managedFunctionType - ManagedFunctionType.

managedFunctionNode - ManagedFunctionNode.

compileContext - CompileContext.

getOverridePropertyList

public PropertyList getOverridePropertyList()

Description copied from interface: OverrideProperties

Obtains the override PropertyList.

Specified by:

getOverridePropertyList in interface OverrideProperties

Returns:

Override PropertyList.

getAdditionalProfiles

public java.lang.String[] getAdditionalProfiles()

Description copied from interface: OfficeNode

Obtains the additional profiles.

Specified by:

getAdditionalProfiles in interface OfficeNode

Returns:

Additional profiles.

getOfficeFloorNode

public OfficeFloorNode getOfficeFloorNode()

Description copied from interface: OfficeNode

Obtains the OfficeFloorNode containing this OfficeNode.

Specified by:

getOfficeFloorNode in interface OfficeNode

Returns:

OfficeFloorNode containing this OfficeNode.

addManagedObjectSource

public OfficeManagedObjectSource addManagedObjectSource(java.lang.String managedObjectSourceName,
                                                        SuppliedManagedObjectSourceNode suppliedManagedObject)

Description copied from interface: OfficeNode

Adds a OfficeManagedObjectSource supplied from an OfficeSupplier.

Specified by:

addManagedObjectSource in interface OfficeNode

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

suppliedManagedObject - SuppliedManagedObjectSourceNode to supply the OfficeManagedObjectSource.

Returns:

OfficeManagedObjectSource.

sourceOfficeWithTopLevelSections

public boolean sourceOfficeWithTopLevelSections(ManagedObjectSourceVisitor managedObjectSourceVisitor,
                                                CompileContext compileContext)

Description copied from interface: OfficeNode

Sources this Office along with its top level OfficeSection instances into this OfficeNode.

Specified by:

sourceOfficeWithTopLevelSections in interface OfficeNode

Parameters:

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

sourceOfficeTree

public boolean sourceOfficeTree(ManagedObjectSourceVisitor managedObjectSourceVisitor,
                                AutoWirerVisitor autoWirerVisitor,
                                CompileContext compileContext)

Description copied from interface: OfficeNode

Sources this Office and all descendant Node instances.

Specified by:

sourceOfficeTree in interface OfficeNode

Parameters:

managedObjectSourceVisitor - ManagedObjectSourceVisitor.

compileContext - CompileContext.

Returns:

true if successfully sourced. Otherwise false with issue reported to the CompilerIssues.

getAvailableTypes

public AvailableType[] getAvailableTypes(CompileContext compileContext)

Description copied from interface: OfficeNode

Obtains the AvailableType instances.

Specified by:

getAvailableTypes in interface OfficeNode

Parameters:

compileContext - CompileContext.

Returns:

AvailableType instances.

loadOfficeType

public OfficeType loadOfficeType(CompileContext compileContext)

Description copied from interface: OfficeNode

Loads the OfficeType.

Specified by:

loadOfficeType in interface OfficeNode

Parameters:

compileContext - CompileContext.

Returns:

OfficeType or null if issue loading with issue reported to the CompilerIssues.

autoWireObjects

public void autoWireObjects(AutoWirer<LinkObjectNode> autoWirer,
                            CompileContext compileContext)

Description copied from interface: OfficeNode

Auto-wires the OfficeObjectNode instances that are unlinked.

Specified by:

autoWireObjects in interface OfficeNode

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

autoWireTeams

public void autoWireTeams(AutoWirer<LinkTeamNode> autoWirer,
                          CompileContext compileContext)

Description copied from interface: OfficeNode

Auto-wires the OfficeTeamNode instances that are unlinked.

Specified by:

autoWireTeams in interface OfficeNode

Parameters:

autoWirer - AutoWirer.

compileContext - CompileContext.

runExecutionExplorers

public boolean runExecutionExplorers(CompileContext compileContext)

Description copied from interface: OfficeNode

Runs the ExecutionExplorer instances.

Specified by:

runExecutionExplorers in interface OfficeNode

Parameters:

compileContext - CompileContext.

Returns:

true if successfully explored execution.

buildOffice

public OfficeBindings buildOffice(OfficeFloorBuilder builder,
                                  CompileContext compileContext,
                                  Profiler profiler)

Description copied from interface: OfficeNode

Builds the Office for this OfficeNode.

Specified by:

buildOffice in interface OfficeNode

Parameters:

builder - OfficeFloorBuilder.

compileContext - CompileContext.

profiler - Optional Profiler. May be null.

Returns:

OfficeBuilder for the built Office.

loadExternalServicing

public void loadExternalServicing(Office office)
                           throws UnknownFunctionException

Description copied from interface: OfficeNode

Loads the FunctionManager instances to externally trigger this OfficeNode.

Specified by:

loadExternalServicing in interface OfficeNode

Parameters:

office - Office for this OfficeNode.

Throws:

UnknownFunctionException - UnknownFunctionException.

getInternalSuppliers

public InternalSupplier[] getInternalSuppliers()

Description copied from interface: OfficeNode

Obtains the InternalSupplier instances for the Office.

Specified by:

getInternalSuppliers in interface OfficeNode

Returns:

InternalSupplier instances for the Office.

enableAutoWireObjects

public void enableAutoWireObjects()

Description copied from interface: OfficeArchitect

Flags to attempt to auto wire any non-configured object links.

Specified by:

enableAutoWireObjects in interface OfficeArchitect

enableAutoWireTeams

public void enableAutoWireTeams()

Description copied from interface: OfficeArchitect

Flags to attempt to auto wire any non-configured Team links.

Specified by:

enableAutoWireTeams in interface OfficeArchitect

addOfficeObject

public OfficeObject addOfficeObject(java.lang.String officeManagedObjectName,
                                    java.lang.String objectType)

Description copied from interface: OfficeArchitect

Adds an OfficeObject.

Specified by:

addOfficeObject in interface OfficeArchitect

Parameters:

officeManagedObjectName - Name of the OfficeObject.

objectType - Object type.

Returns:

Added OfficeObject.

addOfficeInput

public OfficeInput addOfficeInput(java.lang.String inputName,
                                  java.lang.String parameterType)

Description copied from interface: OfficeArchitect

Adds a OfficeInput.

Specified by:

addOfficeInput in interface OfficeArchitect

Parameters:

inputName - Name of the OfficeInput.

parameterType - Fully qualified type name of the parameter to this OfficeInput.

Returns:

Added OfficeInput.

addOfficeOutput

public OfficeOutput addOfficeOutput(java.lang.String outputName,
                                    java.lang.String argumentType)

Description copied from interface: OfficeArchitect

Adds a OfficeOutput.

Specified by:

addOfficeOutput in interface OfficeArchitect

Parameters:

outputName - Name of the OfficeOutput.

argumentType - Fully qualified type name of the argument from this OfficeOutput.

Returns:

Added OfficeOutput.

addOfficeTeam

public OfficeTeam addOfficeTeam(java.lang.String officeTeamName)

Description copied from interface: OfficeArchitect

Adds an OfficeTeam.

Specified by:

addOfficeTeam in interface OfficeArchitect

Parameters:

officeTeamName - Name of the OfficeTeam.

Returns:

Added OfficeTeam.

addOfficeSection

public OfficeSection addOfficeSection(java.lang.String sectionName,
                                      java.lang.String sectionSourceClassName,
                                      java.lang.String sectionLocation)

Description copied from interface: OfficeArchitect

Adds an OfficeSection.

Specified by:

addOfficeSection in interface OfficeArchitect

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - Fully qualified class name of the SectionSource.

sectionLocation - Location of the OfficeSection.

Returns:

Added OfficeSection.

addOfficeSection

public OfficeSection addOfficeSection(java.lang.String sectionName,
                                      SectionSource sectionSource,
                                      java.lang.String sectionLocation)

Description copied from interface: OfficeArchitect

Adds an OfficeSection.

Specified by:

addOfficeSection in interface OfficeArchitect

Parameters:

sectionName - Name of the OfficeSection.

sectionSource - SectionSource instance to use.

sectionLocation - Location of the OfficeSection.

Returns:

Added OfficeSection.

getOfficeSection

public OfficeSection getOfficeSection(java.lang.String sectionName)

Description copied from interface: OfficeArchitect

Obtains the OfficeSection.

Specified by:

getOfficeSection in interface OfficeArchitect

Parameters:

sectionName - Name of the OfficeSection.

Returns:

OfficeSection.

addOfficeSectionTransformer

public void addOfficeSectionTransformer(OfficeSectionTransformer transformer)

Description copied from interface: OfficeArchitect

Adds an OfficeSectionTransformer to transform the OfficeSection instances of the Office.

Specified by:

addOfficeSectionTransformer in interface OfficeArchitect

Parameters:

transformer - OfficeSectionTransformer.

addManagedFunctionAugmentor

public void addManagedFunctionAugmentor(ManagedFunctionAugmentor managedFunctionAugmentor)

Description copied from interface: OfficeArchitect

Adds a ManagedFunctionAugmentor.

Specified by:

addManagedFunctionAugmentor in interface OfficeArchitect

Parameters:

managedFunctionAugmentor - ManagedFunctionAugmentor.

addOfficeManagedObjectSource

public OfficeManagedObjectSource addOfficeManagedObjectSource(java.lang.String managedObjectSourceName,
                                                              java.lang.String managedObjectSourceClassName)

Description copied from interface: OfficeArchitect

Adds a OfficeManagedObjectSource.

Specified by:

addOfficeManagedObjectSource in interface OfficeArchitect

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource.

Returns:

Added OfficeManagedObjectSource.

addOfficeManagedObjectSource

public OfficeManagedObjectSource addOfficeManagedObjectSource(java.lang.String managedObjectSourceName,
                                                              ManagedObjectSource<?,?> managedObjectSource)

Description copied from interface: OfficeArchitect

Adds a OfficeManagedObjectSource.

Specified by:

addOfficeManagedObjectSource in interface OfficeArchitect

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

Added OfficeManagedObjectSource.

addManagedObjectPool

public OfficeManagedObjectPool addManagedObjectPool(java.lang.String managedObjectPoolName,
                                                    java.lang.String managedObjectPoolSourceClassName)

Description copied from interface: OfficeArchitect

Adds an OfficeManagedObjectPool.

Specified by:

addManagedObjectPool in interface OfficeArchitect

Parameters:

managedObjectPoolName - Name of the OfficeManagedObjectPool.

managedObjectPoolSourceClassName - Fully qualified class name of the ManagedObjectPoolSource.

Returns:

Added OfficeManagedObjectPool.

addManagedObjectPool

public OfficeManagedObjectPool addManagedObjectPool(java.lang.String managedObjectPoolName,
                                                    ManagedObjectPoolSource managedObjectPoolSource)

Description copied from interface: OfficeArchitect

Adds an OfficeManagedObjectPool.

Specified by:

addManagedObjectPool in interface OfficeArchitect

Parameters:

managedObjectPoolName - Name of the OfficeManagedObjectPool.

managedObjectPoolSource - ManagedObjectPoolSource instance to use.

Returns:

OfficeManagedObjectPool.

addSupplier

public OfficeSupplier addSupplier(java.lang.String supplierName,
                                  java.lang.String supplierSourceClassName)

Description copied from interface: OfficeArchitect

Adds an OfficeSupplier.

Specified by:

addSupplier in interface OfficeArchitect

Parameters:

supplierName - Name of the OfficeSupplier.

supplierSourceClassName - Fully qualified class name of the SupplierSource.

Returns:

OfficeSupplier.

addSupplier

public OfficeSupplier addSupplier(java.lang.String supplierName,
                                  SupplierSource supplierSource)

Description copied from interface: OfficeArchitect

Adds an OfficeSupplier.

Specified by:

addSupplier in interface OfficeArchitect

Parameters:

supplierName - Name of the OfficeSupplier.

supplierSource - SupplierSource instance to use.

Returns:

OfficeFloorSupplier.

addOfficeGovernance

public OfficeGovernance addOfficeGovernance(java.lang.String governanceName,
                                            java.lang.String governanceSourceClassName)

Description copied from interface: OfficeArchitect

Adds a OfficeGovernance.

Specified by:

addOfficeGovernance in interface OfficeArchitect

Parameters:

governanceName - Name of the OfficeGovernance.

governanceSourceClassName - Fully qualified class name of the GovernanceSource.

Returns:

Added OfficeGovernance.

addOfficeGovernance

public OfficeGovernance addOfficeGovernance(java.lang.String governanceName,
                                            GovernanceSource<?,?> governanceSource)

Description copied from interface: OfficeArchitect

Adds an OfficeGovernance.

Specified by:

addOfficeGovernance in interface OfficeArchitect

Parameters:

governanceName - Name of the OfficeGovernance.

governanceSource - GovernanceSource instance to use.

Returns:

Added OfficeGovernance.

addOfficeAdministration

public OfficeAdministration addOfficeAdministration(java.lang.String administrationName,
                                                    java.lang.String administrationSourceClassName)

Description copied from interface: OfficeArchitect

Adds an OfficeAdministration.

Specified by:

addOfficeAdministration in interface OfficeArchitect

Parameters:

administrationName - Name of the OfficeAdministration.

administrationSourceClassName - Fully qualified class name of the AdministrationSource.

Returns:

Added OfficeAdministration.

addOfficeAdministration

public OfficeAdministration addOfficeAdministration(java.lang.String administrationName,
                                                    AdministrationSource<?,?,?> administrationSource)

Description copied from interface: OfficeArchitect

Adds an OfficeAdministration.

Specified by:

addOfficeAdministration in interface OfficeArchitect

Parameters:

administrationName - Name of the OfficeAdministration.

administrationSource - AdministrationSource instance to use.

Returns:

Added OfficeAdministration.

addOfficeEscalation

public OfficeEscalation addOfficeEscalation(java.lang.String escalationTypeName)

Description copied from interface: OfficeArchitect

Adds an OfficeEscalation.

Specified by:

addOfficeEscalation in interface OfficeArchitect

Parameters:

escalationTypeName - Type of Escalation.

Returns:

Added OfficeEscalation.

addOfficeEscalationExplorer

public void addOfficeEscalationExplorer(EscalationExplorer escalationExplorer)

Description copied from interface: OfficeArchitect

Adds an EscalationExplorer for the execution tree from the added OfficeEscalation instances.

Specified by:

addOfficeEscalationExplorer in interface OfficeArchitect

Parameters:

escalationExplorer - EscalationExplorer.

addOfficeCompletionExplorer

public void addOfficeCompletionExplorer(CompletionExplorer completionExplorer)

Description copied from interface: OfficeArchitect

Adds a CompletionExplorer to be notified of completion of exploring the execution tree.

Specified by:

addOfficeCompletionExplorer in interface OfficeArchitect

Parameters:

completionExplorer - CompletionExplorer.

addOfficeStart

public OfficeStart addOfficeStart(java.lang.String startName)

Description copied from interface: OfficeArchitect

Adds an OfficeStart.

Specified by:

addOfficeStart in interface OfficeArchitect

Parameters:

startName - Name of the OfficeStart.

Returns:

Added OfficeStart.

link

public void link(OfficeManagedObjectSource managedObjectSource,
                 OfficeManagedObjectPool managedObjectPool)

Description copied from interface: OfficeArchitect

Links the OfficeManagedObjectSource to be pooled by the OfficeManagedObjectPool.

Specified by:

link in interface OfficeArchitect

Parameters:

managedObjectSource - OfficeManagedObjectSource.

managedObjectPool - OfficeManagedObjectPool.

link

public void link(OfficeFlowSourceNode flowSourceNode,
                 OfficeFlowSinkNode flowSinkNode)

Description copied from interface: OfficeArchitect

Links the OfficeFlowSourceNode to be undertaken by the OfficeFlowSinkNode.

Specified by:

link in interface OfficeArchitect

Parameters:

flowSourceNode - OfficeFlowSourceNode.

flowSinkNode - OfficeFlowSinkNode.

link

public void link(OfficeDependencyRequireNode dependencyRequiredNode,
                 OfficeDependencyObjectNode dependencyObjectNode)

Description copied from interface: OfficeArchitect

Links the OfficeDependencyRequireNode to be fulfilled by the OfficeDependencyObjectNode.

Specified by:

link in interface OfficeArchitect

Parameters:

dependencyRequiredNode - OfficeDependencyRequireNode.

dependencyObjectNode - OfficeDependencyObjectNode.

link

public void link(OfficeResponsibility responsibility,
                 OfficeTeam officeTeam)

Description copied from interface: OfficeArchitect

Links the OfficeResponsibility to the OfficeTeam.

Specified by:

link in interface OfficeArchitect

Parameters:

responsibility - OfficeResponsibility.

officeTeam - OfficeTeam.

startBefore

public void startBefore(OfficeManagedObjectSource startEarlier,
                        OfficeManagedObjectSource startLater)

Description copied from interface: OfficeArchitect

Flags an OfficeManagedObjectSource to be started before another OfficeManagedObjectSource.

Specified by:

startBefore in interface OfficeArchitect

Parameters:

startEarlier - OfficeManagedObjectSource to be started up before.

startLater - OfficeManagedObjectSource to be started up afterwards.

startBefore

public void startBefore(OfficeManagedObjectSource managedObjectSource,
                        java.lang.String managedObjectTypeName)

Description copied from interface: OfficeArchitect

Flags an OfficeManagedObjectSource to be started before ManagedObjectSource instances providing the type.

Specified by:

startBefore in interface OfficeArchitect

Parameters:

managedObjectSource - OfficeManagedObjectSource to be started up before.

managedObjectTypeName - Fully qualified type name of ManagedObject object type for the ManagedObjectSource to be started up afterwards.

startAfter

public void startAfter(OfficeManagedObjectSource startLater,
                       OfficeManagedObjectSource startEarlier)

Description copied from interface: OfficeArchitect

Flags an OfficeManagedObjectSource to be started after another OfficeManagedObjectSource.

Specified by:

startAfter in interface OfficeArchitect

Parameters:

startLater - OfficeManagedObjectSource to be started up afterwards.

startEarlier - OfficeManagedObjectSource to be started up before.

startAfter

public void startAfter(OfficeManagedObjectSource managedObjectSource,
                       java.lang.String managedObjectTypeName)

Description copied from interface: OfficeArchitect

Flags an OfficeManagedObjectSource to be started after ManagedObjectSource instances providing the type.

Specified by:

startAfter in interface OfficeArchitect

Parameters:

managedObjectSource - OfficeManagedObjectSource to be started up after.

managedObjectTypeName - Fully qualified type name of ManagedObject object type for the ManagedObjectSource to be started up beforehand.

addIssue

public CompileError addIssue(java.lang.String issueDescription)

Description copied from interface: SourceIssues

Allows the source to add an issue.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

addIssue

public CompileError addIssue(java.lang.String issueDescription,
                             java.lang.Throwable cause)

Description copied from interface: SourceIssues

Allows the source to add an issue along with its cause.

This is available to report invalid configuration.

Specified by:

addIssue in interface SourceIssues

Parameters:

issueDescription - Description of the issue.

cause - Cause of the issue.

Returns:

CompileError to be used in throw statement when adding CompilerIssue to avoid further compiling.

getDeployedOfficeName

public java.lang.String getDeployedOfficeName()

Description copied from interface: DeployedOffice

Obtains the name of this DeployedOffice.

Specified by:

getDeployedOfficeName in interface DeployedOffice

Returns:

Name of this DeployedOffice.

addAdditionalProfile

public void addAdditionalProfile(java.lang.String profile)

Description copied from interface: DeployedOffice

Adds an additional profile specific to the DeployedOffice.

All Node instances within this DeployedOffice will have this additional profile.

Specified by:

addAdditionalProfile in interface DeployedOffice

Parameters:

profile - Profile specific to the DeployedOffice.

addProperty

public void addProperty(java.lang.String name,
                        java.lang.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.

addOverrideProperty

public void addOverrideProperty(java.lang.String name,
                                java.lang.String value)

Description copied from interface: DeployedOffice

Adds an override Property.

This allows overriding configuration of the DeployedOffice. Property instances match on qualified name of the Node. The remainder of the name is the Property name being overridden for the Node.

Specified by:

addOverrideProperty in interface DeployedOffice

Parameters:

name - Name of Property.

value - Value for Property.

getDeployedOfficeInput

public DeployedOfficeInput getDeployedOfficeInput(java.lang.String sectionName,
                                                  java.lang.String inputName)

Description copied from interface: DeployedOffice

Obtains the DeployedOfficeInput for the OfficeAvailableSectionInputType.

Specified by:

getDeployedOfficeInput in interface DeployedOffice

Parameters:

sectionName - Name of the OfficeSection providing the OfficeAvailableSectionInputType.

inputName - Name of the OfficeAvailableSectionInputType.

Returns:

DeployedOfficeInput.

getDeployedOfficeObject

public OfficeObject getDeployedOfficeObject(java.lang.String officeManagedObjectName)

Description copied from interface: DeployedOffice

Obtains the OfficeObject for the OfficeManagedObjectType.

Specified by:

getDeployedOfficeObject in interface DeployedOffice

Parameters:

officeManagedObjectName - Name of the OfficeManagedObjectType.

Returns:

OfficeObject.

getDeployedOfficeTeam

public OfficeTeam getDeployedOfficeTeam(java.lang.String officeTeamName)

Description copied from interface: DeployedOffice

Obtains the OfficeTeam for the OfficeTeamType.

Specified by:

getDeployedOfficeTeam in interface DeployedOffice

Parameters:

officeTeamName - Name of the OfficeTeamType.

Returns:

OfficeTeam.

linkOfficeNode

public boolean linkOfficeNode(LinkOfficeNode node)

Description copied from interface: LinkOfficeNode

Links the input LinkOfficeNode to this LinkOfficeNode.

Specified by:

linkOfficeNode in interface LinkOfficeNode

Parameters:

node - LinkOfficeNode to link to this LinkOfficeNode.

Returns:

true if linked.

getLinkedOfficeNode

public LinkOfficeNode getLinkedOfficeNode()

Description copied from interface: LinkOfficeNode

Obtains the LinkOfficeNode linked to this LinkOfficeNode.

Specified by:

getLinkedOfficeNode in interface LinkOfficeNode

Returns:

LinkOfficeNode linked to this LinkOfficeNode.