Package net.officefloor.frame.impl.construct.managedobjectsource

Class RawManagingOfficeMetaData<F extends java.lang.Enum<F>>

java.lang.Object

net.officefloor.frame.impl.construct.managedobjectsource.RawManagingOfficeMetaData<F>

public class RawManagingOfficeMetaData<F extends java.lang.Enum<F>>
extends java.lang.Object

RawManagingOfficeMetaData implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
RawManagingOfficeMetaData(java.lang.String managingOfficeName, java.lang.String recycleFunctionName, InputManagedObjectConfiguration<?> inputConfiguration, ManagedObjectFlowMetaData<F>[] flowMetaDatas, ManagedObjectExecutionMetaData[] executionMetaDatas, ManagingOfficeConfiguration<F> managingOfficeConfiguration, ManagedFunctionInvocation[] startupInvocations)	Initialise.

Method Summary

Modifier and Type	Method	Description
InputManagedObjectConfiguration<?>	getInputManagedObjectConfiguration()	Indicates if the ManagedObjectSource requires instigating Flow instances.
ManagedObjectExecuteManagerFactory<F>	getManagedObjectExecuteManagerFactory()	Obtains the ManagedObjectExecuteManagerFactory for the ManagedObjectSource.
java.lang.String	getManagingOfficeName()	Obtains the name for the Office managing the ManagedObject.
RawManagedObjectMetaData<?,F>	getRawManagedObjectMetaData()	Obtains the InputManagedObjectConfiguration configuring the bind of the ManagedObject within the ProcessState of the Office.
boolean	isRequireFlows()	Obtains the RawManagedObjectMetaData for the ManagedObject to be managed by the Office.
static boolean	isRequireFlows(ManagedObjectFlowMetaData<?>[] flowMetaData)	Determines if the ManagedObjectSource instigates Flow instances.
void	manageByOffice(OfficeMetaData officeMetaData, RawBoundManagedObjectMetaData[] processBoundManagedObjectMetaData, ManagedObjectAdministrationMetaDataFactory moAdminFactory, java.util.concurrent.ThreadFactory[] defaultExecutionStrategy, java.util.Map<java.lang.String,java.util.concurrent.ThreadFactory[]> executionStrategies, AssetManagerRegistry assetManagerRegistry, long defaultAsynchronousFlowTimeout, OfficeFloorIssues issues)	Sets up the ManagedObjectSource to be managed by the Office of the input ManagedFunctionLocator.
void	manageManagedObject(RawBoundManagedObjectInstanceMetaData<?> boundInstanceMetaData, AssetManagerRegistry assetManagerRegistry, long defaultAsynchronousFlowTimeout)	Adds a ManagedObjectMetaData to be managed by the managing Office.
void	setRawManagedObjectMetaData(RawManagedObjectMetaData<?,F> rawManagedObjectMetaData)	Specifies the RawManagedObjectMetaData.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RawManagingOfficeMetaData

public RawManagingOfficeMetaData(java.lang.String managingOfficeName,
                                 java.lang.String recycleFunctionName,
                                 InputManagedObjectConfiguration<?> inputConfiguration,
                                 ManagedObjectFlowMetaData<F>[] flowMetaDatas,
                                 ManagedObjectExecutionMetaData[] executionMetaDatas,
                                 ManagingOfficeConfiguration<F> managingOfficeConfiguration,
                                 ManagedFunctionInvocation[] startupInvocations)

Initialise.

Parameters:

managingOfficeName - Name of the managing Office.

recycleFunctionName - Name of the ManagedFunction to recycle the ManagedObject.

inputConfiguration - InputManagedObjectConfiguration to configure binding the input ManagedObject to the ProcessState.

flowMetaDatas - ManagedObjectFlowMetaData instances for the ManagedObjectSource.

executionMetaDatas - ManagedObjectExecutionMetaData instances for the ManagedObjectSource.

managingOfficeConfiguration - ManagingOfficeConfiguration.

startupInvocations - Start up ManagedFunctionInvocation instances.

Method Detail

isRequireFlows

public static boolean isRequireFlows(ManagedObjectFlowMetaData<?>[] flowMetaData)

Determines if the ManagedObjectSource instigates Flow instances.

Parameters:

flowMetaData - ManagedObjectFlowMetaData instances of the ManagedObjectSource.

Returns:

true if ManagedObjectSource instigates Flow instances.

setRawManagedObjectMetaData

public void setRawManagedObjectMetaData(RawManagedObjectMetaData<?,F> rawManagedObjectMetaData)

Specifies the RawManagedObjectMetaData.

Parameters:

rawManagedObjectMetaData - RawManagedObjectMetaData.

manageManagedObject

public void manageManagedObject(RawBoundManagedObjectInstanceMetaData<?> boundInstanceMetaData,
                                AssetManagerRegistry assetManagerRegistry,
                                long defaultAsynchronousFlowTimeout)

Adds a ManagedObjectMetaData to be managed by the managing Office.

Parameters:

boundInstanceMetaData - RawBoundManagedObjectInstanceMetaData for the ManagedObjectMetaData.

assetManagerRegistry - AssetManagerRegistry.

defaultAsynchronousFlowTimeout - Default AsynchronousFlow timeout.

getManagingOfficeName

public java.lang.String getManagingOfficeName()

Obtains the name for the Office managing the ManagedObject.

Returns:

Name for the Office managing the ManagedObject.

getInputManagedObjectConfiguration

public InputManagedObjectConfiguration<?> getInputManagedObjectConfiguration()

Indicates if the ManagedObjectSource requires instigating Flow instances.

If true it means the ManagedObjectSource must be bound to the ProcessState of the Office.

Returns:

true if the ManagedObjectSource requires instigating Flow instances.

getRawManagedObjectMetaData

public RawManagedObjectMetaData<?,F> getRawManagedObjectMetaData()

Obtains the InputManagedObjectConfiguration configuring the bind of the ManagedObject within the ProcessState of the Office.

Should the ManagedObjectSource instigate a Flow, a ManagedObject from the ManagedObjectSource is to be made available to the ProcessState. Whether the Office wants to make use of the ManagedObject is its choice but is available to do so.

Returns:

InputManagedObjectConfiguration configuring the bind of the ManagedObject within the ProcessState of the Office.

isRequireFlows

public boolean isRequireFlows()

Obtains the RawManagedObjectMetaData for the ManagedObject to be managed by the Office.

Returns:

RawManagedObjectMetaData for the ManagedObject to be managed by the Office.

manageByOffice

public void manageByOffice(OfficeMetaData officeMetaData,
                           RawBoundManagedObjectMetaData[] processBoundManagedObjectMetaData,
                           ManagedObjectAdministrationMetaDataFactory moAdminFactory,
                           java.util.concurrent.ThreadFactory[] defaultExecutionStrategy,
                           java.util.Map<java.lang.String,java.util.concurrent.ThreadFactory[]> executionStrategies,
                           AssetManagerRegistry assetManagerRegistry,
                           long defaultAsynchronousFlowTimeout,
                           OfficeFloorIssues issues)

Sets up the ManagedObjectSource to be managed by the Office of the input ManagedFunctionLocator.

Parameters:

officeMetaData - OfficeMetaData.

processBoundManagedObjectMetaData - RawBoundManagedObjectMetaData of the ProcessState bound ManagedObject instances of the managing Office.

moAdminFactory - ManagedObjectAdministrationMetaDataFactory.

defaultExecutionStrategy - Default ExecutionStrategy.

executionStrategies - ExecutionStrategy instances by their name.

assetManagerRegistry - AssetManagerRegistry.

defaultAsynchronousFlowTimeout - Default AsynchronousFlow timeout.

issues - OfficeFloorIssues.

getManagedObjectExecuteManagerFactory

public ManagedObjectExecuteManagerFactory<F> getManagedObjectExecuteManagerFactory()

Obtains the ManagedObjectExecuteManagerFactory for the ManagedObjectSource.

Returns:

ManagedObjectExecuteManagerFactory for the ManagedObjectSource.