net.officefloor.compile.internal.structure

Interface WorkNode

All Superinterfaces:

Node, PropertyConfigurable, SectionWork

All Known Implementing Classes:

WorkNodeImpl

public interface WorkNode
extends Node, SectionWork

SectionWork node.

Author:

Daniel Sagenschneider

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
WorkBuilder<?>	buildWork(OfficeBuilder builder, TypeContext typeContext) Builds the Work for this SectionWork.
String	getQualifiedWorkName() Obtains the name of this Work qualified with the OfficeSection hierarchy containing this Work.
SectionNode	getSectionNode() Obtains the SectionNode containing this WorkNode.
void	initialise(String workSourceClassName, WorkSource<?> workSource) Initialises the WorkNode.
WorkType<?>	loadWorkType() Obtains the WorkType for this WorkNode.

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

getLocation, getNodeName, getNodeType, getParentNode, isInitialised

Methods inherited from interface net.officefloor.compile.spi.section.SectionWork

addSectionTask, getSectionWorkName, setInitialTask

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

addProperty

Field Detail

TYPE

static final String TYPE

Node type.

See Also:

Constant Field Values

Method Detail

initialise

void initialise(String workSourceClassName,
                WorkSource<?> workSource)

Initialises the WorkNode.

Parameters:

workSourceClassName - Class name of the WorkSource.

workSource - Optional instantiated WorkSource. May be null.

getSectionNode

SectionNode getSectionNode()

Obtains the SectionNode containing this WorkNode.

Returns:

SectionNode containing this WorkNode.

getQualifiedWorkName

String getQualifiedWorkName()

Obtains the name of this Work qualified with the OfficeSection hierarchy containing this Work.

Returns:

Qualified name of this Work.

loadWorkType

WorkType<?> loadWorkType()

Obtains the WorkType for this WorkNode.

Returns:

WorkType for this WorkNode. May be null if can not load the WorkType.

buildWork

WorkBuilder<?> buildWork(OfficeBuilder builder,
                         TypeContext typeContext)

Builds the Work for this SectionWork.

Parameters:

builder - OfficeBuilder.

typeContext - TypeContext.

Returns:

WorkBuilder to enable building the TaskNode instances.