org.bimserver.models.ifc4.IfcAsset 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.ifc4;

/**
 * 
 * A representation of the model object 'Ifc Asset'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcAsset#getIdentification Identification}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getOriginalValue Original Value}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getCurrentValue Current Value}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getTotalReplacementCost Total Replacement Cost}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getOwner Owner}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getUser User}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getResponsiblePerson Responsible Person}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getIncorporationDate Incorporation Date}
 *   {@link org.bimserver.models.ifc4.IfcAsset#getDepreciatedValue Depreciated Value}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset()
 * @model
 * @generated
 */
public interface IfcAsset extends IfcGroup {
	/**
	 * Returns the value of the 'Identification' attribute.
	 * 
	 * 
	 * If the meaning of the 'Identification' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Identification' attribute.
	 * @see #isSetIdentification()
	 * @see #unsetIdentification()
	 * @see #setIdentification(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_Identification()
	 * @model unsettable="true"
	 * @generated
	 */
	String getIdentification();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getIdentification Identification}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Identification' attribute.
	 * @see #isSetIdentification()
	 * @see #unsetIdentification()
	 * @see #getIdentification()
	 * @generated
	 */
	void setIdentification(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getIdentification Identification}' attribute.
	 * 
	 * 
	 * @see #isSetIdentification()
	 * @see #getIdentification()
	 * @see #setIdentification(String)
	 * @generated
	 */
	void unsetIdentification();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getIdentification Identification}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Identification' attribute is set.
	 * @see #unsetIdentification()
	 * @see #getIdentification()
	 * @see #setIdentification(String)
	 * @generated
	 */
	boolean isSetIdentification();

	/**
	 * Returns the value of the 'Original Value' reference.
	 * 
	 * 
	 * If the meaning of the 'Original Value' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Original Value' reference.
	 * @see #isSetOriginalValue()
	 * @see #unsetOriginalValue()
	 * @see #setOriginalValue(IfcCostValue)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_OriginalValue()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcCostValue getOriginalValue();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getOriginalValue Original Value}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Original Value' reference.
	 * @see #isSetOriginalValue()
	 * @see #unsetOriginalValue()
	 * @see #getOriginalValue()
	 * @generated
	 */
	void setOriginalValue(IfcCostValue value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getOriginalValue Original Value}' reference.
	 * 
	 * 
	 * @see #isSetOriginalValue()
	 * @see #getOriginalValue()
	 * @see #setOriginalValue(IfcCostValue)
	 * @generated
	 */
	void unsetOriginalValue();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getOriginalValue Original Value}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Original Value' reference is set.
	 * @see #unsetOriginalValue()
	 * @see #getOriginalValue()
	 * @see #setOriginalValue(IfcCostValue)
	 * @generated
	 */
	boolean isSetOriginalValue();

	/**
	 * Returns the value of the 'Current Value' reference.
	 * 
	 * 
	 * If the meaning of the 'Current Value' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Current Value' reference.
	 * @see #isSetCurrentValue()
	 * @see #unsetCurrentValue()
	 * @see #setCurrentValue(IfcCostValue)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_CurrentValue()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcCostValue getCurrentValue();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getCurrentValue Current Value}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Current Value' reference.
	 * @see #isSetCurrentValue()
	 * @see #unsetCurrentValue()
	 * @see #getCurrentValue()
	 * @generated
	 */
	void setCurrentValue(IfcCostValue value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getCurrentValue Current Value}' reference.
	 * 
	 * 
	 * @see #isSetCurrentValue()
	 * @see #getCurrentValue()
	 * @see #setCurrentValue(IfcCostValue)
	 * @generated
	 */
	void unsetCurrentValue();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getCurrentValue Current Value}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Current Value' reference is set.
	 * @see #unsetCurrentValue()
	 * @see #getCurrentValue()
	 * @see #setCurrentValue(IfcCostValue)
	 * @generated
	 */
	boolean isSetCurrentValue();

	/**
	 * Returns the value of the 'Total Replacement Cost' reference.
	 * 
	 * 
	 * If the meaning of the 'Total Replacement Cost' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Total Replacement Cost' reference.
	 * @see #isSetTotalReplacementCost()
	 * @see #unsetTotalReplacementCost()
	 * @see #setTotalReplacementCost(IfcCostValue)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_TotalReplacementCost()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcCostValue getTotalReplacementCost();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getTotalReplacementCost Total Replacement Cost}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Total Replacement Cost' reference.
	 * @see #isSetTotalReplacementCost()
	 * @see #unsetTotalReplacementCost()
	 * @see #getTotalReplacementCost()
	 * @generated
	 */
	void setTotalReplacementCost(IfcCostValue value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getTotalReplacementCost Total Replacement Cost}' reference.
	 * 
	 * 
	 * @see #isSetTotalReplacementCost()
	 * @see #getTotalReplacementCost()
	 * @see #setTotalReplacementCost(IfcCostValue)
	 * @generated
	 */
	void unsetTotalReplacementCost();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getTotalReplacementCost Total Replacement Cost}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Total Replacement Cost' reference is set.
	 * @see #unsetTotalReplacementCost()
	 * @see #getTotalReplacementCost()
	 * @see #setTotalReplacementCost(IfcCostValue)
	 * @generated
	 */
	boolean isSetTotalReplacementCost();

	/**
	 * Returns the value of the 'Owner' reference.
	 * 
	 * 
	 * If the meaning of the 'Owner' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Owner' reference.
	 * @see #isSetOwner()
	 * @see #unsetOwner()
	 * @see #setOwner(IfcActorSelect)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_Owner()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcActorSelect getOwner();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getOwner Owner}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Owner' reference.
	 * @see #isSetOwner()
	 * @see #unsetOwner()
	 * @see #getOwner()
	 * @generated
	 */
	void setOwner(IfcActorSelect value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getOwner Owner}' reference.
	 * 
	 * 
	 * @see #isSetOwner()
	 * @see #getOwner()
	 * @see #setOwner(IfcActorSelect)
	 * @generated
	 */
	void unsetOwner();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getOwner Owner}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Owner' reference is set.
	 * @see #unsetOwner()
	 * @see #getOwner()
	 * @see #setOwner(IfcActorSelect)
	 * @generated
	 */
	boolean isSetOwner();

	/**
	 * Returns the value of the 'User' reference.
	 * 
	 * 
	 * If the meaning of the 'User' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User' reference.
	 * @see #isSetUser()
	 * @see #unsetUser()
	 * @see #setUser(IfcActorSelect)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_User()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcActorSelect getUser();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getUser User}' reference.
	 * 
	 * 
	 * @param value the new value of the 'User' reference.
	 * @see #isSetUser()
	 * @see #unsetUser()
	 * @see #getUser()
	 * @generated
	 */
	void setUser(IfcActorSelect value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getUser User}' reference.
	 * 
	 * 
	 * @see #isSetUser()
	 * @see #getUser()
	 * @see #setUser(IfcActorSelect)
	 * @generated
	 */
	void unsetUser();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getUser User}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'User' reference is set.
	 * @see #unsetUser()
	 * @see #getUser()
	 * @see #setUser(IfcActorSelect)
	 * @generated
	 */
	boolean isSetUser();

	/**
	 * Returns the value of the 'Responsible Person' reference.
	 * 
	 * 
	 * If the meaning of the 'Responsible Person' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Responsible Person' reference.
	 * @see #isSetResponsiblePerson()
	 * @see #unsetResponsiblePerson()
	 * @see #setResponsiblePerson(IfcPerson)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_ResponsiblePerson()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcPerson getResponsiblePerson();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getResponsiblePerson Responsible Person}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Responsible Person' reference.
	 * @see #isSetResponsiblePerson()
	 * @see #unsetResponsiblePerson()
	 * @see #getResponsiblePerson()
	 * @generated
	 */
	void setResponsiblePerson(IfcPerson value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getResponsiblePerson Responsible Person}' reference.
	 * 
	 * 
	 * @see #isSetResponsiblePerson()
	 * @see #getResponsiblePerson()
	 * @see #setResponsiblePerson(IfcPerson)
	 * @generated
	 */
	void unsetResponsiblePerson();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getResponsiblePerson Responsible Person}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Responsible Person' reference is set.
	 * @see #unsetResponsiblePerson()
	 * @see #getResponsiblePerson()
	 * @see #setResponsiblePerson(IfcPerson)
	 * @generated
	 */
	boolean isSetResponsiblePerson();

	/**
	 * Returns the value of the 'Incorporation Date' attribute.
	 * 
	 * 
	 * If the meaning of the 'Incorporation Date' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Incorporation Date' attribute.
	 * @see #isSetIncorporationDate()
	 * @see #unsetIncorporationDate()
	 * @see #setIncorporationDate(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_IncorporationDate()
	 * @model unsettable="true"
	 * @generated
	 */
	String getIncorporationDate();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getIncorporationDate Incorporation Date}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Incorporation Date' attribute.
	 * @see #isSetIncorporationDate()
	 * @see #unsetIncorporationDate()
	 * @see #getIncorporationDate()
	 * @generated
	 */
	void setIncorporationDate(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getIncorporationDate Incorporation Date}' attribute.
	 * 
	 * 
	 * @see #isSetIncorporationDate()
	 * @see #getIncorporationDate()
	 * @see #setIncorporationDate(String)
	 * @generated
	 */
	void unsetIncorporationDate();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getIncorporationDate Incorporation Date}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Incorporation Date' attribute is set.
	 * @see #unsetIncorporationDate()
	 * @see #getIncorporationDate()
	 * @see #setIncorporationDate(String)
	 * @generated
	 */
	boolean isSetIncorporationDate();

	/**
	 * Returns the value of the 'Depreciated Value' reference.
	 * 
	 * 
	 * If the meaning of the 'Depreciated Value' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Depreciated Value' reference.
	 * @see #isSetDepreciatedValue()
	 * @see #unsetDepreciatedValue()
	 * @see #setDepreciatedValue(IfcCostValue)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAsset_DepreciatedValue()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcCostValue getDepreciatedValue();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getDepreciatedValue Depreciated Value}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Depreciated Value' reference.
	 * @see #isSetDepreciatedValue()
	 * @see #unsetDepreciatedValue()
	 * @see #getDepreciatedValue()
	 * @generated
	 */
	void setDepreciatedValue(IfcCostValue value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getDepreciatedValue Depreciated Value}' reference.
	 * 
	 * 
	 * @see #isSetDepreciatedValue()
	 * @see #getDepreciatedValue()
	 * @see #setDepreciatedValue(IfcCostValue)
	 * @generated
	 */
	void unsetDepreciatedValue();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAsset#getDepreciatedValue Depreciated Value}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Depreciated Value' reference is set.
	 * @see #unsetDepreciatedValue()
	 * @see #getDepreciatedValue()
	 * @see #setDepreciatedValue(IfcCostValue)
	 * @generated
	 */
	boolean isSetDepreciatedValue();

} // IfcAsset