org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship 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
The newest version!
/**
 * 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;

import org.bimserver.emf.IdEObject;

/**
 * 
 * A representation of the model object 'Ifc Currency Relationship'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRelatingMonetaryUnit Relating Monetary Unit}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRelatedMonetaryUnit Related Monetary Unit}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getExchangeRate Exchange Rate}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getExchangeRateAsString Exchange Rate As String}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRateDateTime Rate Date Time}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRateSource Rate Source}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface IfcCurrencyRelationship extends IdEObject {
	/**
	 * Returns the value of the 'Relating Monetary Unit' reference.
	 * 
	 * 
	 * If the meaning of the 'Relating Monetary Unit' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Relating Monetary Unit' reference.
	 * @see #setRelatingMonetaryUnit(IfcMonetaryUnit)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship_RelatingMonetaryUnit()
	 * @model
	 * @generated
	 */
	IfcMonetaryUnit getRelatingMonetaryUnit();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRelatingMonetaryUnit Relating Monetary Unit}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Relating Monetary Unit' reference.
	 * @see #getRelatingMonetaryUnit()
	 * @generated
	 */
	void setRelatingMonetaryUnit(IfcMonetaryUnit value);

	/**
	 * Returns the value of the 'Related Monetary Unit' reference.
	 * 
	 * 
	 * If the meaning of the 'Related Monetary Unit' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Related Monetary Unit' reference.
	 * @see #setRelatedMonetaryUnit(IfcMonetaryUnit)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship_RelatedMonetaryUnit()
	 * @model
	 * @generated
	 */
	IfcMonetaryUnit getRelatedMonetaryUnit();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRelatedMonetaryUnit Related Monetary Unit}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Related Monetary Unit' reference.
	 * @see #getRelatedMonetaryUnit()
	 * @generated
	 */
	void setRelatedMonetaryUnit(IfcMonetaryUnit value);

	/**
	 * Returns the value of the 'Exchange Rate' attribute.
	 * 
	 * 
	 * If the meaning of the 'Exchange Rate' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Exchange Rate' attribute.
	 * @see #setExchangeRate(double)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship_ExchangeRate()
	 * @model
	 * @generated
	 */
	double getExchangeRate();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getExchangeRate Exchange Rate}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Exchange Rate' attribute.
	 * @see #getExchangeRate()
	 * @generated
	 */
	void setExchangeRate(double value);

	/**
	 * Returns the value of the 'Exchange Rate As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Exchange Rate As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Exchange Rate As String' attribute.
	 * @see #setExchangeRateAsString(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship_ExchangeRateAsString()
	 * @model
	 * @generated
	 */
	String getExchangeRateAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getExchangeRateAsString Exchange Rate As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Exchange Rate As String' attribute.
	 * @see #getExchangeRateAsString()
	 * @generated
	 */
	void setExchangeRateAsString(String value);

	/**
	 * Returns the value of the 'Rate Date Time' reference.
	 * 
	 * 
	 * If the meaning of the 'Rate Date Time' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Rate Date Time' reference.
	 * @see #setRateDateTime(IfcDateAndTime)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship_RateDateTime()
	 * @model
	 * @generated
	 */
	IfcDateAndTime getRateDateTime();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRateDateTime Rate Date Time}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Rate Date Time' reference.
	 * @see #getRateDateTime()
	 * @generated
	 */
	void setRateDateTime(IfcDateAndTime value);

	/**
	 * Returns the value of the 'Rate Source' reference.
	 * 
	 * 
	 * If the meaning of the 'Rate Source' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Rate Source' reference.
	 * @see #isSetRateSource()
	 * @see #unsetRateSource()
	 * @see #setRateSource(IfcLibraryInformation)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcCurrencyRelationship_RateSource()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcLibraryInformation getRateSource();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRateSource Rate Source}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Rate Source' reference.
	 * @see #isSetRateSource()
	 * @see #unsetRateSource()
	 * @see #getRateSource()
	 * @generated
	 */
	void setRateSource(IfcLibraryInformation value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRateSource Rate Source}' reference.
	 * 
	 * 
	 * @see #isSetRateSource()
	 * @see #getRateSource()
	 * @see #setRateSource(IfcLibraryInformation)
	 * @generated
	 */
	void unsetRateSource();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcCurrencyRelationship#getRateSource Rate Source}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Rate Source' reference is set.
	 * @see #unsetRateSource()
	 * @see #getRateSource()
	 * @see #setRateSource(IfcLibraryInformation)
	 * @generated
	 */
	boolean isSetRateSource();

} // IfcCurrencyRelationship