Package net.officefloor.compile.spi.office

Interface ManagedFunctionAugmentorContext

All Superinterfaces:

SourceIssues

public interface ManagedFunctionAugmentorContext
extends SourceIssues

Context for the ManagedFunctionAugmentor.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addPostAdministration(OfficeAdministration administration)	Adds an OfficeAdministration to be done after completing this ManagedFunction.
void	addPreAdministration(OfficeAdministration administration)	Adds an OfficeAdministration to be done before attempting this ManagedFunction.
AugmentedFunctionObject	getFunctionObject(java.lang.String objectName)	Obtains the AugmentedFunctionObject for the ManagedFunction.
java.lang.String	getManagedFunctionName()	Obtains the name of the ManagedFunction.
ManagedFunctionType<?,?>	getManagedFunctionType()	Obtains the ManagedFunctionType of the ManagedFunction.
void	link(AugmentedFunctionObject object, OfficeManagedObject managedObject)	Links the AugmentedFunctionObject to the OfficeManagedObject.

Methods inherited from interface net.officefloor.compile.issues.SourceIssues

addIssue, addIssue

Method Detail

getManagedFunctionName

java.lang.String getManagedFunctionName()

Obtains the name of the ManagedFunction.

Returns:

Name of the ManagedFunction.

getManagedFunctionType

ManagedFunctionType<?,?> getManagedFunctionType()

Obtains the ManagedFunctionType of the ManagedFunction.

Returns:

ManagedFunctionType of the ManagedFunction.

addPreAdministration

void addPreAdministration(OfficeAdministration administration)

Adds an OfficeAdministration to be done before attempting this ManagedFunction.

The order that the OfficeAdministration instances are added is the order they will be done before this ManagedFunction.

Parameters:

administration - OfficeAdministration to be done before attempting this ManagedFunction.

addPostAdministration

void addPostAdministration(OfficeAdministration administration)

Adds an OfficeAdministration to be done after completing this ManagedFunction.

The order that the OfficeAdministration instances are added is the order they will be done after this ManagedFunction is complete.

Parameters:

administration - OfficeAdministration to be done after completing this ManagedFunction.

getFunctionObject

AugmentedFunctionObject getFunctionObject(java.lang.String objectName)

Obtains the AugmentedFunctionObject for the ManagedFunction.

Parameters:

objectName - Name of the FunctionObject on the ManagedFunction.

Returns:

AugmentedFunctionObject.

link

void link(AugmentedFunctionObject object,
          OfficeManagedObject managedObject)

Links the AugmentedFunctionObject to the OfficeManagedObject.

Parameters:

object - AugmentedFunctionObject.

managedObject - OfficeManagedObject.