net.officefloor.frame.internal.construct

Interface OfficeMetaDataLocator

All Known Implementing Classes:

OfficeMetaDataLocatorImpl

public interface OfficeMetaDataLocator

Locates the meta-data within the OfficeMetaData.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
OfficeMetaDataLocator	createWorkSpecificOfficeMetaDataLocator(WorkMetaData<?> workMetaData) Creates a OfficeMetaDataLocator that defaults to the input WorkMetaData if no Work name is provided.
WorkMetaData<?>	getDefaultWorkMetaData() Obtains the default WorkMetaData.
OfficeMetaData	getOfficeMetaData() Obtains the OfficeMetaData of the Office that TaskMetaData is being located within.
TaskMetaData<?,?,?>	getTaskMetaData(String taskName) Obtains the TaskMetaData on the default WorkMetaData.
TaskMetaData<?,?,?>	getTaskMetaData(String workName, String taskName) Obtains the TaskMetaData by the Work and Task name.
WorkMetaData<?>	getWorkMetaData(String workName) Obtains the WorkMetaData by the Work name.

Method Detail

getOfficeMetaData

OfficeMetaData getOfficeMetaData()

Obtains the OfficeMetaData of the Office that TaskMetaData is being located within.

Returns:

OfficeMetaData of the Office that TaskMetaData is being located within.

getDefaultWorkMetaData

WorkMetaData<?> getDefaultWorkMetaData()

Obtains the default WorkMetaData.

Returns:

Default WorkMetaData.

createWorkSpecificOfficeMetaDataLocator

OfficeMetaDataLocator createWorkSpecificOfficeMetaDataLocator(WorkMetaData<?> workMetaData)

Creates a OfficeMetaDataLocator that defaults to the input WorkMetaData if no Work name is provided.

Parameters:

workMetaData - WorkMetaData of the Work to default searching for TaskMetaData.

Returns:

OfficeMetaDataLocator.

getWorkMetaData

WorkMetaData<?> getWorkMetaData(String workName)

Obtains the WorkMetaData by the Work name.

Parameters:

workName - Name of the Work.

Returns:

WorkMetaData or null if not found.

getTaskMetaData

TaskMetaData<?,?,?> getTaskMetaData(String workName,
                                    String taskName)

Obtains the TaskMetaData by the Work and Task name.

Parameters:

workName - Name of the Work that the Task is on. If null attempts to find TaskMetaData on the default WorkMetaData.

taskName - Name of the Task.

Returns:

TaskMetaData or null if not found.

getTaskMetaData

TaskMetaData<?,?,?> getTaskMetaData(String taskName)

Obtains the TaskMetaData on the default WorkMetaData. If no default WorkMetaData is available, this will always return null.

Parameters:

taskName - Name of the Task on the default Work.

Returns:

TaskMetaData or null if not found.