org.bimserver.models.ifc2x3tc1.IfcObjective 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.ifc2x3tc1;

/**
 * 
 * A representation of the model object 'Ifc Objective'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcObjective#getBenchmarkValues Benchmark Values}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcObjective#getResultValues Result Values}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcObjective#getObjectiveQualifier Objective Qualifier}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcObjective#getUserDefinedQualifier User Defined Qualifier}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcObjective()
 * @model
 * @generated
 */
public interface IfcObjective extends IfcConstraint {
	/**
	 * Returns the value of the 'Benchmark Values' reference.
	 * 
	 * 
	 * If the meaning of the 'Benchmark Values' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Benchmark Values' reference.
	 * @see #isSetBenchmarkValues()
	 * @see #unsetBenchmarkValues()
	 * @see #setBenchmarkValues(IfcMetric)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcObjective_BenchmarkValues()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcMetric getBenchmarkValues();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getBenchmarkValues Benchmark Values}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Benchmark Values' reference.
	 * @see #isSetBenchmarkValues()
	 * @see #unsetBenchmarkValues()
	 * @see #getBenchmarkValues()
	 * @generated
	 */
	void setBenchmarkValues(IfcMetric value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getBenchmarkValues Benchmark Values}' reference.
	 * 
	 * 
	 * @see #isSetBenchmarkValues()
	 * @see #getBenchmarkValues()
	 * @see #setBenchmarkValues(IfcMetric)
	 * @generated
	 */
	void unsetBenchmarkValues();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getBenchmarkValues Benchmark Values}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Benchmark Values' reference is set.
	 * @see #unsetBenchmarkValues()
	 * @see #getBenchmarkValues()
	 * @see #setBenchmarkValues(IfcMetric)
	 * @generated
	 */
	boolean isSetBenchmarkValues();

	/**
	 * Returns the value of the 'Result Values' reference.
	 * 
	 * 
	 * If the meaning of the 'Result Values' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Result Values' reference.
	 * @see #isSetResultValues()
	 * @see #unsetResultValues()
	 * @see #setResultValues(IfcMetric)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcObjective_ResultValues()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcMetric getResultValues();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getResultValues Result Values}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Result Values' reference.
	 * @see #isSetResultValues()
	 * @see #unsetResultValues()
	 * @see #getResultValues()
	 * @generated
	 */
	void setResultValues(IfcMetric value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getResultValues Result Values}' reference.
	 * 
	 * 
	 * @see #isSetResultValues()
	 * @see #getResultValues()
	 * @see #setResultValues(IfcMetric)
	 * @generated
	 */
	void unsetResultValues();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getResultValues Result Values}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Result Values' reference is set.
	 * @see #unsetResultValues()
	 * @see #getResultValues()
	 * @see #setResultValues(IfcMetric)
	 * @generated
	 */
	boolean isSetResultValues();

	/**
	 * Returns the value of the 'Objective Qualifier' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc2x3tc1.IfcObjectiveEnum}.
	 * 
	 * 
	 * If the meaning of the 'Objective Qualifier' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Objective Qualifier' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcObjectiveEnum
	 * @see #setObjectiveQualifier(IfcObjectiveEnum)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcObjective_ObjectiveQualifier()
	 * @model
	 * @generated
	 */
	IfcObjectiveEnum getObjectiveQualifier();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getObjectiveQualifier Objective Qualifier}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Objective Qualifier' attribute.
	 * @see org.bimserver.models.ifc2x3tc1.IfcObjectiveEnum
	 * @see #getObjectiveQualifier()
	 * @generated
	 */
	void setObjectiveQualifier(IfcObjectiveEnum value);

	/**
	 * Returns the value of the 'User Defined Qualifier' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Qualifier' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Qualifier' attribute.
	 * @see #isSetUserDefinedQualifier()
	 * @see #unsetUserDefinedQualifier()
	 * @see #setUserDefinedQualifier(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcObjective_UserDefinedQualifier()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedQualifier();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getUserDefinedQualifier User Defined Qualifier}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Qualifier' attribute.
	 * @see #isSetUserDefinedQualifier()
	 * @see #unsetUserDefinedQualifier()
	 * @see #getUserDefinedQualifier()
	 * @generated
	 */
	void setUserDefinedQualifier(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getUserDefinedQualifier User Defined Qualifier}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedQualifier()
	 * @see #getUserDefinedQualifier()
	 * @see #setUserDefinedQualifier(String)
	 * @generated
	 */
	void unsetUserDefinedQualifier();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcObjective#getUserDefinedQualifier User Defined Qualifier}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Qualifier' attribute is set.
	 * @see #unsetUserDefinedQualifier()
	 * @see #getUserDefinedQualifier()
	 * @see #setUserDefinedQualifier(String)
	 * @generated
	 */
	boolean isSetUserDefinedQualifier();

} // IfcObjective