net.officefloor.eclipse.extension.template.WoofTemplateExtensionSourceExtensionContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of net.officefloor.woof Show documentation

OfficeFloor WoOF Eclipse plug-in

There is a newer version: 3.12.0

/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2013 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.eclipse.extension.template;

import net.officefloor.compile.properties.Property;
import net.officefloor.compile.properties.PropertyList;
import net.officefloor.model.change.Change;
import net.officefloor.plugin.woof.template.WoofTemplateExtensionSource;
import net.officefloor.plugin.woof.template.WoofTemplateExtensionSourceSpecification;

import org.eclipse.core.resources.IProject;

/**
 * Context for the {@link WoofTemplateExtensionSourceExtension}.
 * 
 * @author Daniel Sagenschneider
 */
public interface WoofTemplateExtensionSourceExtensionContext {

	/**
	 * 
	 * Obtains the {@link PropertyList}. All changes to {@link Property}
	 * instances for the {@link WoofTemplateExtensionSource} are to be done on
	 * this {@link PropertyList}.
	 * 

	 * The {@link PropertyList} may be in any state:
	 * 

	 * no value {@link PropertyList} populated from the
	 * {@link WoofTemplateExtensionSourceSpecification} (creating a
	 * {@link WoofTemplateExtensionSource})
	 * any changed state based on editing of the
	 * {@link WoofTemplateExtensionSource}
	 * 
	 * 
	 * @return {@link PropertyList}.
	 */
	PropertyList getPropertyList();

	/**
	 * 
	 * Notifies of a change to the {@link PropertyList}.
	 * 
	 * This allows for to report issues in attempting to source the
	 * {@link Change} from the {@link WoofTemplateExtensionSource} with the
	 * {@link PropertyList}.
	 */
	void notifyPropertiesChanged();

	/**
	 * Specifies an error message. Calling this after notifying of property
	 * changes allows for overriding the error message reported to the user.
	 * 
	 * @param message
	 *            Error message. null indicating no error.
	 */
	void setErrorMessage(String message);

	/**
	 * Obtains the {@link IProject} that is adding the
	 * {@link WoofTemplateExtensionSource}.
	 * 
	 * @return {@link IProject} that is adding the
	 *         {@link WoofTemplateExtensionSource}.
	 */
	IProject getProject();

}