org.bimserver.models.store.ParameterDefinition 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;

/**
 * 
 * A representation of the model object 'Parameter Definition'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.ParameterDefinition#getName Name}
 *   {@link org.bimserver.models.store.ParameterDefinition#isRequired Required}
 *   {@link org.bimserver.models.store.ParameterDefinition#getDescription Description}
 *   {@link org.bimserver.models.store.ParameterDefinition#getType Type}
 *   {@link org.bimserver.models.store.ParameterDefinition#getDefaultValue Default Value}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getParameterDefinition()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface ParameterDefinition extends IdEObject {
	/**
	 * Returns the value of the 'Name' attribute.
	 * 
	 * 
	 * If the meaning of the 'Name' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Name' attribute.
	 * @see #setName(String)
	 * @see org.bimserver.models.store.StorePackage#getParameterDefinition_Name()
	 * @model
	 * @generated
	 */
	String getName();

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

	/**
	 * Returns the value of the 'Required' attribute.
	 * 
	 * 
	 * If the meaning of the 'Required' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Required' attribute.
	 * @see #setRequired(boolean)
	 * @see org.bimserver.models.store.StorePackage#getParameterDefinition_Required()
	 * @model
	 * @generated
	 */
	boolean isRequired();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ParameterDefinition#isRequired Required}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Required' attribute.
	 * @see #isRequired()
	 * @generated
	 */
	void setRequired(boolean 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#getParameterDefinition_Description()
	 * @model
	 * @generated
	 */
	String getDescription();

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

	/**
	 * Returns the value of the 'Type' reference.
	 * 
	 * 
	 * If the meaning of the 'Type' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Type' reference.
	 * @see #setType(TypeDefinition)
	 * @see org.bimserver.models.store.StorePackage#getParameterDefinition_Type()
	 * @model
	 * @generated
	 */
	TypeDefinition getType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ParameterDefinition#getType Type}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Type' reference.
	 * @see #getType()
	 * @generated
	 */
	void setType(TypeDefinition value);

	/**
	 * Returns the value of the 'Default Value' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Value' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Value' reference.
	 * @see #setDefaultValue(Type)
	 * @see org.bimserver.models.store.StorePackage#getParameterDefinition_DefaultValue()
	 * @model
	 * @generated
	 */
	Type getDefaultValue();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ParameterDefinition#getDefaultValue Default Value}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Value' reference.
	 * @see #getDefaultValue()
	 * @generated
	 */
	void setDefaultValue(Type value);

} // ParameterDefinition