Package net.officefloor.compile.spi.office.source

Interface OfficeSourceContext

All Superinterfaces:

ConfigurationContext, SourceContext, SourceProperties

All Known Subinterfaces:

OfficeExtensionContext

All Known Implementing Classes:

OfficeSourceContextImpl

public interface OfficeSourceContext
extends SourceContext, ConfigurationContext

Context for the OfficeSource.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.configuration.ConfigurationContext

DEFAULT_TAG_PREFIX, DEFAULT_TAG_SUFFIX, PROPERTY_CONFIGURATION_INPUT_CHARSET, PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX, PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX, PROPERTY_CONFIGURATION_OUTPUT_CHARSET

Method Summary

Modifier and Type	Method	Description
PropertyList	createPropertyList()	Creates a new PropertyList.
String	getOfficeLocation()	Obtains the location of the Office.
AdministrationType<?,?,?>	loadAdministrationType(String administrationName, String administrationSourceClassName, PropertyList properties)	Loads the AdministrationType.
AdministrationType<?,?,?>	loadAdministrationType(String administrationName, AdministrationSource<?,?,?> administrationSource, PropertyList properties)	Loads the AdministrationType.
GovernanceType<?,?>	loadGovernanceType(String governanceName, String governanceSourceClassName, PropertyList properties)	Loads the GovernanceType.
GovernanceType<?,?>	loadGovernanceType(String governanceName, GovernanceSource<?,?> governanceSource, PropertyList properties)	Loads the GovernanceType.
ManagedObjectType<?>	loadManagedObjectType(String managedObjectSourceName, String managedObjectSourceClassName, PropertyList properties)	Loads the ManagedObjectType.
ManagedObjectType<?>	loadManagedObjectType(String managedObjectSourceName, ManagedObjectSource<?,?> managedObjectSource, PropertyList properties)	Loads the ManagedObjectType.
OfficeSectionType	loadOfficeSectionType(String sectionName, String sectionSourceClassName, String sectionLocation, PropertyList properties)	Loads the OfficeSectionType.
OfficeSectionType	loadOfficeSectionType(String sectionName, SectionSource sectionSource, String sectionLocation, PropertyList properties)	Loads the OfficeSectionType.
InitialSupplierType	loadSupplierType(String supplierName, String supplierSourceClassName, PropertyList properties)	Loads the InitialSupplierType.
InitialSupplierType	loadSupplierType(String supplierName, SupplierSource supplierSource, PropertyList properties)	Loads the InitialSupplierType.

Methods inherited from interface net.officefloor.configuration.ConfigurationContext

getConfigurationItem, getOptionalConfigurationItem

Methods inherited from interface net.officefloor.frame.api.source.SourceContext

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Method Details

getOfficeLocation

String getOfficeLocation()

Obtains the location of the Office.

How "location" is interpreted is for the OfficeSource.

Returns:

Location of the Office.

createPropertyList

PropertyList createPropertyList()

Creates a new PropertyList.

Returns:

New PropertyList.

loadOfficeSectionType

OfficeSectionType loadOfficeSectionType(String sectionName,
 String sectionSourceClassName,
 String sectionLocation,
 PropertyList properties)

Loads the OfficeSectionType.

This is to enable obtaining the type information for the OfficeSection to allow reflective configuration by the OfficeSource.

Parameters:

sectionName - Name of the OfficeSection.

sectionSourceClassName - Name of the implementing SectionSource class.

sectionLocation - Location of the OfficeSection.

properties - PropertyList to configure the OfficeSection.

Returns:

OfficeSectionType or null if fails to load the OfficeSectionType.

loadOfficeSectionType

OfficeSectionType loadOfficeSectionType(String sectionName,
 SectionSource sectionSource,
 String sectionLocation,
 PropertyList properties)

Loads the OfficeSectionType.

This is to enable obtaining the type information for the OfficeSection to allow reflective configuration by the OfficeSource.

Parameters:

sectionName - Name of the OfficeSection.

sectionSource - SectionSource instance.

sectionLocation - Location of the OfficeSection.

properties - PropertyList to configure the OfficeSection.

Returns:

OfficeSectionType or null if fails to load the OfficeSectionType.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(String managedObjectSourceName,
 String managedObjectSourceClassName,
 PropertyList properties)

Loads the ManagedObjectType.

This is to enable obtaining the type information for the ManagedObject to allow reflective configuration by the OfficeSource.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSourceClassName - Name of the implementing ManagedObjectSource class. May also be an alias.

properties - PropertyList to configure the ManagedObjectSource.

Returns:

ManagedObjectType or null if fails to load the ManagedObjectType.

loadManagedObjectType

ManagedObjectType<?> loadManagedObjectType(String managedObjectSourceName,
 ManagedObjectSource<?,?> managedObjectSource,
 PropertyList properties)

Loads the ManagedObjectType.

This is to enable obtaining the type information for the ManagedObject to allow reflective configuration by the OfficeFloorSource.

Parameters:

managedObjectSourceName - Name of the ManagedObjectSource.

managedObjectSource - ManagedObjectSource instance.

properties - PropertyList to configure the ManagedObjectSource.

Returns:

ManagedObjectType or null if fails to load the ManagedObjectType.

loadSupplierType

InitialSupplierType loadSupplierType(String supplierName,
 String supplierSourceClassName,
 PropertyList properties)

Loads the InitialSupplierType.

This is to enable obtaining the type information for the SupplierSource to allow reflective configuration by the OfficeSource.

Parameters:

supplierName - Name of the SupplierSource.

supplierSourceClassName - Name of the implementing SupplierSource class. May also be an alias.

properties - PropertyList to configure the SupplierSource.

Returns:

InitialSupplierType or null if fails to load the InitialSupplierType.

loadSupplierType

InitialSupplierType loadSupplierType(String supplierName,
 SupplierSource supplierSource,
 PropertyList properties)

Loads the InitialSupplierType.

This is to enable obtaining the type information for the SupplierSource to allow reflective configuration by the OfficeSource.

Parameters:

supplierName - Name of the SupplierSource.

supplierSource - SupplierSource.

properties - PropertyList to configure the SupplierSource.

Returns:

InitialSupplierType or null if fails to load the InitialSupplierType.

loadAdministrationType

AdministrationType<?,?,?> loadAdministrationType(String administrationName,
 String administrationSourceClassName,
 PropertyList properties)

Loads the AdministrationType.

This is to enable obtaining the type information for the Administration to allow reflective configuration by the OfficeSource.

Parameters:

administrationName - Name of Administration.

administrationSourceClassName - Name of the implementing AdministrationSource class. May also be an alias.

properties - PropertyList to configure the AdministrationSource.

Returns:

AdministrationType or null if fails to load the AdministrationType.

loadAdministrationType

AdministrationType<?,?,?> loadAdministrationType(String administrationName,
 AdministrationSource<?,?,?> administrationSource,
 PropertyList properties)

Loads the AdministrationType.

This is to enable obtaining the type information for the Administration to allow reflective configuration by the OfficeSource.

Parameters:

administrationName - Name of Administration.

administrationSource - AdministrationSource instance.

properties - PropertyList to configure the AdministrationSource.

Returns:

AdministrationType or null if fails to load the AdministrationType.

loadGovernanceType

GovernanceType<?,?> loadGovernanceType(String governanceName,
 String governanceSourceClassName,
 PropertyList properties)

Loads the GovernanceType.

This is to enable obtaining the type information for the Governance to allow reflective configuration by the OfficeSource.

Parameters:

governanceName - Name of Governance.

governanceSourceClassName - Name of the implementing GovernanceSource class. May also be an alias.

properties - PropertyList for configuring the GovernanceSource.

Returns:

GovernanceType or null if fails to load the GovernanceType.

loadGovernanceType

GovernanceType<?,?> loadGovernanceType(String governanceName,
 GovernanceSource<?,?> governanceSource,
 PropertyList properties)

Loads the GovernanceType.

This is to enable obtaining the type information for the Governance to allow reflective configuration by the OfficeSource.

Parameters:

governanceName - Name of Governance.

governanceSource - GovernanceSource instance.

properties - PropertyList for configuring the GovernanceSource.

Returns:

GovernanceType or null if fails to load the GovernanceType.