Package net.officefloor.frame.api.manage

Interface OfficeFloor

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

OfficeFloorImpl

public interface OfficeFloor
extends java.lang.AutoCloseable

OfficeFloor where ManagedFunction instances are executed within Office instances.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
default void	closeOfficeFloor()	Closes the OfficeFloor.
Office	getOffice(java.lang.String officeName)	Obtains the Office for the input office name.
java.lang.String[]	getOfficeNames()	Obtains the names of the Office instances within this OfficeFloor.
void	openOfficeFloor()	Opens the OfficeFloor and starts necessary ManagedFunction instances.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

openOfficeFloor

void openOfficeFloor()
              throws java.lang.Exception

Opens the OfficeFloor and starts necessary ManagedFunction instances.

Throws:

java.lang.Exception - If fails to open the OfficeFloor.

closeOfficeFloor

default void closeOfficeFloor()
                       throws java.lang.Exception

Closes the OfficeFloor. This stops all ManagedFunction instances executing within the Office instances and releases all resources.

Throws:

java.lang.Exception - If fails to close the OfficeFloor.

getOfficeNames

java.lang.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(java.lang.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.