Package net.officefloor.compile.spi.office

Interface OfficeArchitect

All Superinterfaces:

SourceIssues

All Known Subinterfaces:

OfficeNode

All Known Implementing Classes:

OfficeNodeImpl

public interface OfficeArchitect
extends SourceIssues

Architect to structure the Office.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addManagedFunctionAugmentor(ManagedFunctionAugmentor managedFunctionAugmentor)	Adds a ManagedFunctionAugmentor.
OfficeManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, java.lang.String managedObjectPoolSourceClassName)	Adds an OfficeManagedObjectPool.
OfficeManagedObjectPool	addManagedObjectPool(java.lang.String managedObjectPoolName, ManagedObjectPoolSource managedObjectPoolSource)	Adds an OfficeManagedObjectPool.
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 officeObjectName, 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.
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	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.
OfficeSection	getOfficeSection(java.lang.String sectionName)	Obtains the OfficeSection.
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.
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.

Methods inherited from interface net.officefloor.compile.issues.SourceIssues

addIssue, addIssue

Method Detail

enableAutoWireObjects

void enableAutoWireObjects()

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

enableAutoWireTeams

void enableAutoWireTeams()

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

addOfficeInput

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

Adds a OfficeInput.

Parameters:

inputName - Name of the OfficeInput.

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

Returns:

Added OfficeInput.

addOfficeOutput

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

Adds a OfficeOutput.

Parameters:

outputName - Name of the OfficeOutput.

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

Returns:

Added OfficeOutput.

addOfficeObject

OfficeObject addOfficeObject(java.lang.String officeObjectName,
                             java.lang.String objectType)

Adds an OfficeObject.

Parameters:

officeObjectName - Name of the OfficeObject.

objectType - Object type.

Returns:

Added OfficeObject.

addOfficeTeam

OfficeTeam addOfficeTeam(java.lang.String officeTeamName)

Adds an OfficeTeam.

Parameters:

officeTeamName - Name of the OfficeTeam.

Returns:

Added OfficeTeam.

addOfficeSection

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

Adds an OfficeSection.

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - Fully qualified class name of the SectionSource.

sectionLocation - Location of the OfficeSection.

Returns:

Added OfficeSection.

addOfficeSection

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

Adds an OfficeSection.

Parameters:

sectionName - Name of the OfficeSection.

sectionSource - SectionSource instance to use.

sectionLocation - Location of the OfficeSection.

Returns:

Added OfficeSection.

getOfficeSection

OfficeSection getOfficeSection(java.lang.String sectionName)

Obtains the OfficeSection.

Parameters:

sectionName - Name of the OfficeSection.

Returns:

OfficeSection.

addOfficeSectionTransformer

void addOfficeSectionTransformer(OfficeSectionTransformer transformer)

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

Parameters:

transformer - OfficeSectionTransformer.

addManagedFunctionAugmentor

void addManagedFunctionAugmentor(ManagedFunctionAugmentor managedFunctionAugmentor)

Adds a ManagedFunctionAugmentor.

Parameters:

managedFunctionAugmentor - ManagedFunctionAugmentor.

addOfficeManagedObjectSource

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

Adds a OfficeManagedObjectSource.

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

managedObjectSourceClassName - Fully qualified class name of the ManagedObjectSource.

Returns:

Added OfficeManagedObjectSource.

addOfficeManagedObjectSource

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

Adds a OfficeManagedObjectSource.

Parameters:

managedObjectSourceName - Name of the OfficeManagedObjectSource.

managedObjectSource - ManagedObjectSource instance to use.

Returns:

Added OfficeManagedObjectSource.

addManagedObjectPool

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

Adds an OfficeManagedObjectPool.

Parameters:

managedObjectPoolName - Name of the OfficeManagedObjectPool.

managedObjectPoolSourceClassName - Fully qualified class name of the ManagedObjectPoolSource.

Returns:

Added OfficeManagedObjectPool.

addManagedObjectPool

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

Adds an OfficeManagedObjectPool.

Parameters:

managedObjectPoolName - Name of the OfficeManagedObjectPool.

managedObjectPoolSource - ManagedObjectPoolSource instance to use.

Returns:

OfficeManagedObjectPool.

addSupplier

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

Adds an OfficeSupplier.

Parameters:

supplierName - Name of the OfficeSupplier.

supplierSourceClassName - Fully qualified class name of the SupplierSource.

Returns:

OfficeSupplier.

addSupplier

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

Adds an OfficeSupplier.

Parameters:

supplierName - Name of the OfficeSupplier.

supplierSource - SupplierSource instance to use.

Returns:

OfficeFloorSupplier.

addOfficeGovernance

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

Adds a OfficeGovernance.

Parameters:

governanceName - Name of the OfficeGovernance.

governanceSourceClassName - Fully qualified class name of the GovernanceSource.

Returns:

Added OfficeGovernance.

addOfficeGovernance

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

Adds an OfficeGovernance.

Parameters:

governanceName - Name of the OfficeGovernance.

governanceSource - GovernanceSource instance to use.

Returns:

Added OfficeGovernance.

addOfficeAdministration

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

Adds an OfficeAdministration.

Parameters:

administrationName - Name of the OfficeAdministration.

administrationSourceClassName - Fully qualified class name of the AdministrationSource.

Returns:

Added OfficeAdministration.

addOfficeAdministration

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

Adds an OfficeAdministration.

Parameters:

administrationName - Name of the OfficeAdministration.

administrationSource - AdministrationSource instance to use.

Returns:

Added OfficeAdministration.

addOfficeEscalation

OfficeEscalation addOfficeEscalation(java.lang.String escalationTypeName)

Adds an OfficeEscalation.

Parameters:

escalationTypeName - Type of Escalation.

Returns:

Added OfficeEscalation.

addOfficeEscalationExplorer

void addOfficeEscalationExplorer(EscalationExplorer escalationExplorer)

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

Parameters:

escalationExplorer - EscalationExplorer.

addOfficeCompletionExplorer

void addOfficeCompletionExplorer(CompletionExplorer completionExplorer)

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

Parameters:

completionExplorer - CompletionExplorer.

addOfficeStart

OfficeStart addOfficeStart(java.lang.String startName)

Adds an OfficeStart.

Parameters:

startName - Name of the OfficeStart.

Returns:

Added OfficeStart.

link

void link(OfficeManagedObjectSource managedObjectSource,
          OfficeManagedObjectPool managedObjectPool)

Links the OfficeManagedObjectSource to be pooled by the OfficeManagedObjectPool.

Parameters:

managedObjectSource - OfficeManagedObjectSource.

managedObjectPool - OfficeManagedObjectPool.

link

void link(OfficeFlowSourceNode flowSourceNode,
          OfficeFlowSinkNode flowSinkNode)

Links the OfficeFlowSourceNode to be undertaken by the OfficeFlowSinkNode.

Parameters:

flowSourceNode - OfficeFlowSourceNode.

flowSinkNode - OfficeFlowSinkNode.

link

void link(OfficeDependencyRequireNode dependencyRequiredNode,
          OfficeDependencyObjectNode dependencyObjectNode)

Links the OfficeDependencyRequireNode to be fulfilled by the OfficeDependencyObjectNode.

Parameters:

dependencyRequiredNode - OfficeDependencyRequireNode.

dependencyObjectNode - OfficeDependencyObjectNode.

link

void link(OfficeResponsibility responsibility,
          OfficeTeam officeTeam)

Links the OfficeResponsibility to the OfficeTeam.

Parameters:

responsibility - OfficeResponsibility.

officeTeam - OfficeTeam.

startBefore

void startBefore(OfficeManagedObjectSource startEarlier,
                 OfficeManagedObjectSource startLater)

Flags an OfficeManagedObjectSource to be started before another OfficeManagedObjectSource.

Parameters:

startEarlier - OfficeManagedObjectSource to be started up before.

startLater - OfficeManagedObjectSource to be started up afterwards.

startBefore

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

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

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

void startAfter(OfficeManagedObjectSource startLater,
                OfficeManagedObjectSource startEarlier)

Flags an OfficeManagedObjectSource to be started after another OfficeManagedObjectSource.

Parameters:

startLater - OfficeManagedObjectSource to be started up afterwards.

startEarlier - OfficeManagedObjectSource to be started up before.

startAfter

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

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

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.