net.officefloor.frame.api.manage
Interface OfficeFloor

All Known Implementing Classes:

OfficeFloorImpl

public interface OfficeFloor

Office floor where Work is done within Office instances.

Author:

Daniel Sagenschneider

Method Summary

void	closeOfficeFloor() Closes the floor.
Office	getOffice(String officeName) Obtains the Office for the input office name.
String[]	getOfficeNames() Obtains the names of the Office instances within this OfficeFloor.
void	openOfficeFloor() Opens the floor and starts all Work.

Method Detail

openOfficeFloor

void openOfficeFloor()
                     throws Exception

Opens the floor and starts all Work.

Throws:

Exception - If fails to open the floor.

closeOfficeFloor

void closeOfficeFloor()

Closes the floor. This stops all Work within the Office instances and releases all resources.

getOfficeNames

String[] getOfficeNames()

Obtains the names of the Office instances within this OfficeFloor.

This allows to dynamically manage this OfficeFloor.

Returns:

Names of the Office instances within this OfficeFloor.

getOffice

Office getOffice(String officeName)
                 throws UnknownOfficeException

Obtains the Office for the input office name.

Parameters:

officeName - Name of the Office.

Returns:

Specified Office.

Throws:

UnknownOfficeException - If no Office by the name within this OfficeFloor.