Package net.officefloor.compile.spi.office

Interface OfficeSection

All Superinterfaces:

OfficeSubSection, PropertyConfigurable

All Known Subinterfaces:

SectionNode

All Known Implementing Classes:

SectionNodeImpl

public interface OfficeSection
extends OfficeSubSection, PropertyConfigurable

OfficeSection of the Office.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
OfficeSectionInput	getOfficeSectionInput(String inputName)	Obtains the OfficeSectionInput.
OfficeSectionObject	getOfficeSectionObject(String objectName)	Obtains the OfficeSectionObject.
OfficeSectionOutput	getOfficeSectionOutput(String outputName)	Obtains the OfficeSectionOutput.
void	setSuperOfficeSection(OfficeSection superSection)	Specifies an OfficeSection that this OfficeSection will inherit its links from.

Methods inherited from interface net.officefloor.compile.spi.office.OfficeSubSection

addGovernance, getOfficeSectionFunction, getOfficeSectionManagedObject, getOfficeSectionManagedObjectSource, getOfficeSectionName, getOfficeSubSection

Methods inherited from interface net.officefloor.compile.properties.PropertyConfigurable

addProperty

Method Details

getOfficeSectionInput

OfficeSectionInput getOfficeSectionInput(String inputName)

Obtains the OfficeSectionInput.

Parameters:

inputName - Name of the OfficeSectionInput to obtain.

Returns:

OfficeSectionInput.

getOfficeSectionOutput

OfficeSectionOutput getOfficeSectionOutput(String outputName)

Obtains the OfficeSectionOutput.

Parameters:

outputName - Name of the OfficeSectionOutput to obtain.

Returns:

OfficeSectionOutput.

getOfficeSectionObject

OfficeSectionObject getOfficeSectionObject(String objectName)

Obtains the OfficeSectionObject.

Parameters:

objectName - Name of the OfficeSectionObject to obtain.

Returns:

OfficeSectionObject.

setSuperOfficeSection

void setSuperOfficeSection(OfficeSection superSection)

Specifies an OfficeSection that this OfficeSection will inherit its links from.

Typical example use would be creating an OfficeSection to render a web page. For headers and footers, the various links do not want to have to be configured for each OfficeSection page. This would clutter the graphical configuration. Hence the main page can configure these header and footer links, with all other pages inheriting the links from the main page.

Parameters:

superSection - Super OfficeSection.