net.officefloor.eclipse.extension.officesource
Interface OfficeSourceExtensionContext

All Known Implementing Classes:

OfficeSourceInstance

public interface OfficeSourceExtensionContext

Context for the OfficeSourceExtension.

Author:

Daniel Sagenschneider

Method Summary

org.eclipse.core.resources.IProject	getProject() Obtains the IProject that is adding the Office.
PropertyList	getPropertyList() Obtains the PropertyList.
void	notifyPropertiesChanged() Notifies of a change to the PropertyList.
void	setErrorMessage(String message) Specifies an error message.
void	setTitle(String title) Specifies the title.

Method Detail

setTitle

void setTitle(String title)

Specifies the title.

Parameters:

title - Title.

getPropertyList

PropertyList getPropertyList()

Obtains the PropertyList. All changes to Property instances for the OfficeSource are to be done on this PropertyList.

The PropertyList may be in any state:

1. no value PropertyList populated from the OfficeSourceSpecification (creating a Office)
2. any changed state based on editing of the Office (editing Office)

Returns:

PropertyList.

notifyPropertiesChanged

void notifyPropertiesChanged()

Notifies of a change to the PropertyList.

This allows for to report issues in attempting to source the OfficeType from the OfficeSource with the PropertyList.

setErrorMessage

void setErrorMessage(String message)

Specifies an error message. Calling this after notifying of property changes allows for overriding the error message reported to the user.

Parameters:

message - Error message. null indicating no error.

getProject

org.eclipse.core.resources.IProject getProject()

Obtains the IProject that is adding the Office.

Returns:

IProject that is adding the Office.