Package net.officefloor.frame.internal.structure

Interface OfficeMetaData

All Known Implementing Classes:

OfficeMetaDataImpl

public interface OfficeMetaData

Meta-data for the Office.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
FunctionState	createProcess(FlowMetaData flowMetaData, java.lang.Object parameter, FlowCallback callback, ThreadState callbackThreadState)	Creates a new ProcessState.
ProcessIdentifier	createProcessIdentifier(ProcessState processState)	Creates a ProcessIdentifier for a new ProcessState.
StateManager	createStateManager()	Creates a StateManager.
Executive	getExecutive()	Obtains the Executive for this Office.
java.util.concurrent.Executor	getExecutor(ProcessIdentifier processIdentifier)	Obtains the Executor for the ProcessState.
FunctionLoop	getFunctionLoop()	Obtains the FunctionLoop for the Office.
ManagedExecutionFactory	getManagedExecutionFactory()	Obtains the ManagedExecutionFactory for this Office.
ManagedFunctionLocator	getManagedFunctionLocator()	Obtains the ManagedFunctionLocator.
ManagedFunctionMetaData<?,?>[]	getManagedFunctionMetaData()	Obtains the ManagedFunctionMetaData of the ManagedFunction that may be done within this Office.
MonitorClock	getMonitorClock()	Obtains the MonitorClock for the Office.
OfficeManager	getOfficeManager(ProcessIdentifier processIdentifier)	Obtains the OfficeManager for the ProcessState.
java.lang.String	getOfficeName()	Obtains the name of the Office.
ProcessMetaData	getProcessMetaData()	Obtains the ProcessMetaData for processes within this Office.
OfficeStartupFunction[]	getStartupFunctions()	Obtains the OfficeStartupFunction instances for this Office.
ProcessManager	invokeProcess(FlowMetaData flowMetaData, java.lang.Object parameter, long delay, FlowCallback callback, ThreadState callbackThreadState, ManagedObject inputManagedObject, ManagedObjectMetaData<?> inputManagedObjectMetaData, int processBoundIndexForInputManagedObject)	Invokes a ProcessState.
OfficeManager	setupDefaultOfficeManager()	Sets up the default OfficeManager.

Method Detail

getOfficeName

java.lang.String getOfficeName()

Obtains the name of the Office.

Returns:

Name of the Office.

setupDefaultOfficeManager

OfficeManager setupDefaultOfficeManager()

Sets up the default OfficeManager.

Returns:

Default OfficeManager.

createProcessIdentifier

ProcessIdentifier createProcessIdentifier(ProcessState processState)

Creates a ProcessIdentifier for a new ProcessState.

Parameters:

processState - New ProcessState.

Returns:

New ProcessIdentifier.

getOfficeManager

OfficeManager getOfficeManager(ProcessIdentifier processIdentifier)

Obtains the OfficeManager for the ProcessState.

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState.

Returns:

OfficeManager of the Office.

getExecutor

java.util.concurrent.Executor getExecutor(ProcessIdentifier processIdentifier)

Obtains the Executor for the ProcessState.

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState.

Returns:

Executor for the ProcessState.

getMonitorClock

MonitorClock getMonitorClock()

Obtains the MonitorClock for the Office.

Returns:

MonitorClock for the Office.

getProcessMetaData

ProcessMetaData getProcessMetaData()

Obtains the ProcessMetaData for processes within this Office.

Returns:

ProcessMetaData for processes within this Office.

getFunctionLoop

FunctionLoop getFunctionLoop()

Obtains the FunctionLoop for the Office.

Returns:

FunctionLoop for the Office.

getManagedFunctionMetaData

ManagedFunctionMetaData<?,?>[] getManagedFunctionMetaData()

Obtains the ManagedFunctionMetaData of the ManagedFunction that may be done within this Office.

Returns:

ManagedFunctionMetaData instances of this Office.

getManagedFunctionLocator

ManagedFunctionLocator getManagedFunctionLocator()

Obtains the ManagedFunctionLocator.

Returns:

ManagedFunctionLocator.

getStartupFunctions

OfficeStartupFunction[] getStartupFunctions()

Obtains the OfficeStartupFunction instances for this Office.

Returns:

OfficeStartupFunction instances for this Office.

getExecutive

Executive getExecutive()

Obtains the Executive for this Office.

Returns:

Executive for this Office.

getManagedExecutionFactory

ManagedExecutionFactory getManagedExecutionFactory()

Obtains the ManagedExecutionFactory for this Office.

Returns:

ManagedExecutionFactory for this Office.

createProcess

FunctionState createProcess(FlowMetaData flowMetaData,
                            java.lang.Object parameter,
                            FlowCallback callback,
                            ThreadState callbackThreadState)

Creates a new ProcessState.

Parameters:

flowMetaData - FlowMetaData of the starting FunctionState for the ProcessState.

parameter - Parameter to the starting FunctionState.

callback - Optional FlowCallback of the ProcessState. May be null.

callbackThreadState - Optional ThreadState for the FlowCallback. May be null.

Returns:

FunctionState to start processing the ProcessState.

invokeProcess

ProcessManager invokeProcess(FlowMetaData flowMetaData,
                             java.lang.Object parameter,
                             long delay,
                             FlowCallback callback,
                             ThreadState callbackThreadState,
                             ManagedObject inputManagedObject,
                             ManagedObjectMetaData<?> inputManagedObjectMetaData,
                             int processBoundIndexForInputManagedObject)
                      throws InvalidParameterTypeException

Invokes a ProcessState.

Parameters:

flowMetaData - FlowMetaData of the starting FunctionState for the ProcessState.

parameter - Parameter to the starting FunctionState.

delay - Millisecond delay in invoking the ProcessState. 0 (or negative value) will invoke immediately on the current Thread.

callback - Optional FlowCallback of the ProcessState. May be null.

callbackThreadState - Optional ThreadState for the FlowCallback. May be null.

inputManagedObject - ManagedObject that possibly invoked the new ProcessState. This may be null and if so the remaining parameters will be ignored.

inputManagedObjectMetaData - ManagedObjectMetaData for the ManagedObject that invoked the new ProcessState. Should the ManagedObject be provided this must then also be provided.

processBoundIndexForInputManagedObject - Index of the ManagedObject within the ProcessState. Ignored if ManagedObject passed in is null.

Returns:

ProcessManager for the invoked ProcessState.

Throws:

InvalidParameterTypeException - Should the type of parameter be invalid for the initial ManagedFunction.

createStateManager

StateManager createStateManager()

Creates a StateManager.

Returns:

Statement.