Interface OfficeNode
- All Superinterfaces:
DeployedOffice,LinkOfficeNode,ManagedObjectRegistry,Node,OfficeArchitect,OfficeTeamRegistry,OverrideProperties,PropertyConfigurable,SourceIssues
- All Known Implementing Classes:
OfficeNodeImpl
public interface OfficeNode
extends LinkOfficeNode, ManagedObjectRegistry, OfficeTeamRegistry, OverrideProperties, OfficeArchitect, DeployedOffice
Office node.- Author:
- Daniel Sagenschneider
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionaddManagedObjectSource(String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject) Adds aOfficeManagedObjectSourcesupplied from anOfficeSupplier.voidautoWireObjects(AutoWirer<LinkObjectNode> autoWirer, CompileContext compileContext) Auto-wires theOfficeObjectNodeinstances that are unlinked.voidautoWireTeams(AutoWirer<LinkTeamNode> autoWirer, CompileContext compileContext) Auto-wires theOfficeTeamNodeinstances that are unlinked.buildOffice(OfficeFloorBuilder builder, CompileContext compileContext, Profiler profiler) Builds theOfficefor thisOfficeNode.String[]Obtains the additional profiles.getAvailableTypes(CompileContext compileContext) Obtains theAvailableTypeinstances.Obtains theInternalSupplierinstances for theOffice.Obtains theOfficeFloorNodecontaining thisOfficeNode.voidinitialise(String officeSourceClassName, OfficeSource officeSource, String officeLocation) Initialises theOfficeNode.voidloadExternalServicing(Office office) Loads theFunctionManagerinstances to externally trigger thisOfficeNode.loadOfficeType(CompileContext compileContext) Loads theOfficeType.booleanrunExecutionExplorers(CompileContext compileContext) Runs theExecutionExplorerinstances.booleansourceOfficeTree(ManagedObjectSourceVisitor managedObjectSourceVisitor, AutoWirerVisitor autoWirerVisitor, CompileContext compileContext) booleansourceOfficeWithTopLevelSections(ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext) Methods inherited from interface net.officefloor.compile.spi.officefloor.DeployedOffice
addAdditionalProfile, addOverrideProperty, getDeployedOfficeInput, getDeployedOfficeName, getDeployedOfficeObject, getDeployedOfficeTeamMethods inherited from interface net.officefloor.compile.internal.structure.LinkOfficeNode
getLinkedOfficeNode, linkOfficeNodeMethods inherited from interface net.officefloor.compile.internal.structure.ManagedObjectRegistry
addManagedObjectNode, getManagedObjectNodeMethods inherited from interface net.officefloor.compile.internal.structure.Node
getChildNodes, getLocation, getNodeName, getNodeType, getParentNode, getQualifiedName, getQualifiedName, isInitialisedMethods inherited from interface net.officefloor.compile.spi.office.OfficeArchitect
addManagedFunctionAugmentor, addManagedObjectPool, addManagedObjectPool, addOfficeAdministration, addOfficeAdministration, addOfficeCompletionExplorer, addOfficeEscalation, addOfficeEscalationExplorer, addOfficeGovernance, addOfficeGovernance, addOfficeInput, addOfficeManagedObjectSource, addOfficeManagedObjectSource, addOfficeObject, addOfficeOutput, addOfficeSection, addOfficeSection, addOfficeSectionTransformer, addOfficeStart, addOfficeTeam, addSupplier, addSupplier, enableAutoWireObjects, enableAutoWireTeams, getOfficeSection, link, link, link, link, startAfter, startAfter, startBefore, startBeforeMethods inherited from interface net.officefloor.compile.internal.structure.OfficeTeamRegistry
createOfficeTeam, getOfficeTeamsMethods inherited from interface net.officefloor.compile.internal.structure.OverrideProperties
getOverridePropertyListMethods inherited from interface net.officefloor.compile.properties.PropertyConfigurable
addPropertyMethods inherited from interface net.officefloor.compile.issues.SourceIssues
addIssue, addIssue
-
Field Details
-
TYPE
Nodetype.- See Also:
-
-
Method Details
-
initialise
Initialises theOfficeNode.- Parameters:
officeSourceClassName-OfficeSourceclass name.officeSource- Optional instantiatedOfficeSource. May benull.officeLocation- Location of theOffice.
-
getAdditionalProfiles
String[] getAdditionalProfiles()Obtains the additional profiles.- Returns:
- Additional profiles.
-
addManagedObjectSource
OfficeManagedObjectSource addManagedObjectSource(String managedObjectSourceName, SuppliedManagedObjectSourceNode suppliedManagedObject) Adds aOfficeManagedObjectSourcesupplied from anOfficeSupplier.- Parameters:
managedObjectSourceName- Name of theOfficeManagedObjectSource.suppliedManagedObject-SuppliedManagedObjectSourceNodeto supply theOfficeManagedObjectSource.- Returns:
OfficeManagedObjectSource.
-
sourceOfficeWithTopLevelSections
boolean sourceOfficeWithTopLevelSections(ManagedObjectSourceVisitor managedObjectSourceVisitor, CompileContext compileContext) - Parameters:
managedObjectSourceVisitor-ManagedObjectSourceVisitor.compileContext-CompileContext.- Returns:
trueif successfully sourced. Otherwisefalsewith issue reported to theCompilerIssues.
-
sourceOfficeTree
boolean sourceOfficeTree(ManagedObjectSourceVisitor managedObjectSourceVisitor, AutoWirerVisitor autoWirerVisitor, CompileContext compileContext) - Parameters:
managedObjectSourceVisitor-ManagedObjectSourceVisitor.autoWirerVisitor-AutoWirerVisitor.compileContext-CompileContext.- Returns:
trueif successfully sourced. Otherwisefalsewith issue reported to theCompilerIssues.
-
getOfficeFloorNode
OfficeFloorNode getOfficeFloorNode()Obtains theOfficeFloorNodecontaining thisOfficeNode.- Returns:
OfficeFloorNodecontaining thisOfficeNode.
-
loadOfficeType
Loads theOfficeType.- Parameters:
compileContext-CompileContext.- Returns:
OfficeTypeornullif issue loading with issue reported to theCompilerIssues.
-
getAvailableTypes
Obtains theAvailableTypeinstances.- Parameters:
compileContext-CompileContext.- Returns:
AvailableTypeinstances.
-
autoWireObjects
Auto-wires theOfficeObjectNodeinstances that are unlinked.- Parameters:
autoWirer-AutoWirer.compileContext-CompileContext.
-
autoWireTeams
Auto-wires theOfficeTeamNodeinstances that are unlinked.- Parameters:
autoWirer-AutoWirer.compileContext-CompileContext.
-
runExecutionExplorers
Runs theExecutionExplorerinstances.- Parameters:
compileContext-CompileContext.- Returns:
trueif successfully explored execution.
-
buildOffice
OfficeBindings buildOffice(OfficeFloorBuilder builder, CompileContext compileContext, Profiler profiler) Builds theOfficefor thisOfficeNode.- Parameters:
builder-OfficeFloorBuilder.compileContext-CompileContext.profiler- OptionalProfiler. May benull.- Returns:
OfficeBuilderfor the builtOffice.
-
loadExternalServicing
Loads theFunctionManagerinstances to externally trigger thisOfficeNode.- Parameters:
office-Officefor thisOfficeNode.- Throws:
UnknownFunctionException-UnknownFunctionException.
-
getInternalSuppliers
InternalSupplier[] getInternalSuppliers()Obtains theInternalSupplierinstances for theOffice.- Returns:
InternalSupplierinstances for theOffice.
-