org.bimserver.models.store.PluginDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of PluginBase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
There is a newer version: 2.0.0
/**
 * Copyright (C) 2009-2014 BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.bimserver.models.store;

import org.bimserver.emf.IdEObject;
import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Plugin Descriptor'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.PluginDescriptor#getSimpleName Simple Name}
 *   {@link org.bimserver.models.store.PluginDescriptor#getDefaultName Default Name}
 *   {@link org.bimserver.models.store.PluginDescriptor#getPluginClassName Plugin Class Name}
 *   {@link org.bimserver.models.store.PluginDescriptor#getDescription Description}
 *   {@link org.bimserver.models.store.PluginDescriptor#getLocation Location}
 *   {@link org.bimserver.models.store.PluginDescriptor#getEnabled Enabled}
 *   {@link org.bimserver.models.store.PluginDescriptor#getPluginInterfaceClassName Plugin Interface Class Name}
 *   {@link org.bimserver.models.store.PluginDescriptor#getConfigurations Configurations}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface PluginDescriptor extends IdEObject {
	/**
	 * Returns the value of the 'Simple Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Simple Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Simple Name' attribute.
	 * @see #setSimpleName(String)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_SimpleName()
	 * @model
	 * @generated
	 */
	String getSimpleName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getSimpleName Simple Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Simple Name' attribute.
	 * @see #getSimpleName()
	 * @generated
	 */
	void setSimpleName(String value);

	/**
	 * Returns the value of the 'Default Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Default Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Name' attribute.
	 * @see #setDefaultName(String)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_DefaultName()
	 * @model
	 * @generated
	 */
	String getDefaultName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getDefaultName Default Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Default Name' attribute.
	 * @see #getDefaultName()
	 * @generated
	 */
	void setDefaultName(String value);

	/**
	 * Returns the value of the 'Plugin Class Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Plugin Class Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Plugin Class Name' attribute.
	 * @see #setPluginClassName(String)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_PluginClassName()
	 * @model
	 * @generated
	 */
	String getPluginClassName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getPluginClassName Plugin Class Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Plugin Class Name' attribute.
	 * @see #getPluginClassName()
	 * @generated
	 */
	void setPluginClassName(String value);

	/**
	 * Returns the value of the 'Description' attribute.
	 * 
	 * 
	 * If the meaning of the 'Description' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Description' attribute.
	 * @see #setDescription(String)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_Description()
	 * @model
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getDescription Description}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Description' attribute.
	 * @see #getDescription()
	 * @generated
	 */
	void setDescription(String value);

	/**
	 * Returns the value of the 'Location' attribute.
	 * 
	 * 
	 * If the meaning of the 'Location' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Location' attribute.
	 * @see #setLocation(String)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_Location()
	 * @model
	 * @generated
	 */
	String getLocation();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getLocation Location}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Location' attribute.
	 * @see #getLocation()
	 * @generated
	 */
	void setLocation(String value);

	/**
	 * Returns the value of the 'Enabled' attribute.
	 * 
	 * 
	 * If the meaning of the 'Enabled' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Enabled' attribute.
	 * @see #setEnabled(Boolean)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_Enabled()
	 * @model
	 * @generated
	 */
	Boolean getEnabled();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getEnabled Enabled}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Enabled' attribute.
	 * @see #getEnabled()
	 * @generated
	 */
	void setEnabled(Boolean value);

	/**
	 * Returns the value of the 'Plugin Interface Class Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Plugin Interface Class Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Plugin Interface Class Name' attribute.
	 * @see #setPluginInterfaceClassName(String)
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_PluginInterfaceClassName()
	 * @model
	 * @generated
	 */
	String getPluginInterfaceClassName();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.PluginDescriptor#getPluginInterfaceClassName Plugin Interface Class Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Plugin Interface Class Name' attribute.
	 * @see #getPluginInterfaceClassName()
	 * @generated
	 */
	void setPluginInterfaceClassName(String value);

	/**
	 * Returns the value of the 'Configurations' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.PluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.PluginConfiguration#getPluginDescriptor Plugin Descriptor}'.
	 * 
	 * 
	 * If the meaning of the 'Configurations' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Configurations' reference list.
	 * @see org.bimserver.models.store.StorePackage#getPluginDescriptor_Configurations()
	 * @see org.bimserver.models.store.PluginConfiguration#getPluginDescriptor
	 * @model opposite="pluginDescriptor"
	 * @generated
	 */
	EList getConfigurations();

} // PluginDescriptor