Package net.officefloor.compile.internal.structure

Interface OfficeObjectNode

All Superinterfaces:

AdministerableManagedObject, DependentManagedObject, GovernerableManagedObject, LinkObjectNode, Node, OfficeDependencyObjectNode, OfficeFloorDependencyRequireNode, OfficeObject

All Known Implementing Classes:

OfficeObjectNodeImpl

public interface OfficeObjectNode
extends LinkObjectNode, OfficeObject

OfficeObject node.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE	Node type.

Method Summary

Modifier and Type	Method	Description
void	addAdministrator(AdministrationNode administrator)	Adds an AdministrationNode for this OfficeManagedObjectType.
void	addGovernance(GovernanceNode governance)	Adds a GovernanceNode providing Governance for this OfficeObject.
GovernanceNode[]	getGovernances()	Obtains the GovernanceNode instances to provide Governance over BoundManagedObjectNode linked to this OfficeObjectNode.
java.lang.String	getOfficeObjectType()	Obtains the type of the OfficeObject.
AdministrationNode[]	getPreLoadAdministrations()	Obtains the AdministrationNode instances to provide pre-load Administration over BoundManagedObjectNode linked to this OfficeObjectNode.
java.lang.String	getTypeQualifier()	Obtains the type qualifier for the OfficeObject.
void	initialise(java.lang.String objectType)	Initialises this OfficeManagedObjectType.
OfficeManagedObjectType	loadOfficeManagedObjectType(CompileContext compileContext)	Loads the OfficeManagedObjectType for this OfficeObjectNode.

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

getAdministerableManagedObjectName

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

getDependentManagedObjectName

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

getGovernerableManagedObjectName

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

getLinkedObjectNode, linkObjectNode

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

getChildNodes, getLocation, getNodeName, getNodeType, getParentNode, getQualifiedName, getQualifiedName, isInitialised

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

addPreLoadAdministration, getOfficeObjectName, setTypeQualifier

Field Detail

TYPE

static final java.lang.String TYPE

Node type.

See Also:

Constant Field Values

Method Detail

initialise

void initialise(java.lang.String objectType)

Initialises this OfficeManagedObjectType.

Parameters:

objectType - Object type.

addAdministrator

void addAdministrator(AdministrationNode administrator)

Adds an AdministrationNode for this OfficeManagedObjectType.

This allows the OfficeManagedObjectType to report the extension types required to be supported by the OfficeFloorManagedObject for the OfficeObject.

Parameters:

administrator - AdministrationNode.

getPreLoadAdministrations

AdministrationNode[] getPreLoadAdministrations()

Obtains the AdministrationNode instances to provide pre-load Administration over BoundManagedObjectNode linked to this OfficeObjectNode.

Returns:

AdministrationNode instances.

addGovernance

void addGovernance(GovernanceNode governance)

Adds a GovernanceNode providing Governance for this OfficeObject.

This also allows the OfficeManagedObjectType to report the extension interfaces required to be supported by the OfficeFloorManagedObject for the OfficeObject.

Parameters:

governance - GovernanceNode.

getGovernances

GovernanceNode[] getGovernances()

Obtains the GovernanceNode instances to provide Governance over BoundManagedObjectNode linked to this OfficeObjectNode.

Returns:

GovernanceNode instances.

getOfficeObjectType

java.lang.String getOfficeObjectType()

Obtains the type of the OfficeObject.

Returns:

Type of the OfficeObject.

getTypeQualifier

java.lang.String getTypeQualifier()

Obtains the type qualifier for the OfficeObject.

Returns:

Type qualifier for the OfficeObject.

loadOfficeManagedObjectType

OfficeManagedObjectType loadOfficeManagedObjectType(CompileContext compileContext)

Loads the OfficeManagedObjectType for this OfficeObjectNode.

Parameters:

compileContext - CompileContext.

Returns:

OfficeManagedObjectType or null with issues reported to the CompilerIssues.