org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument 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;
import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Ifc References Value Document'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getReferencedDocument Referenced Document}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getReferencingValues Referencing Values}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getName Name}
 *   {@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getDescription Description}
 * 
 *
 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReferencesValueDocument()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface IfcReferencesValueDocument extends IdEObject {
	/**
	 * Returns the value of the 'Referenced Document' reference.
	 * 
	 * 
	 * If the meaning of the 'Referenced Document' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Referenced Document' reference.
	 * @see #setReferencedDocument(IfcDocumentSelect)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReferencesValueDocument_ReferencedDocument()
	 * @model
	 * @generated
	 */
	IfcDocumentSelect getReferencedDocument();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getReferencedDocument Referenced Document}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Referenced Document' reference.
	 * @see #getReferencedDocument()
	 * @generated
	 */
	void setReferencedDocument(IfcDocumentSelect value);

	/**
	 * Returns the value of the 'Referencing Values' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc2x3tc1.IfcAppliedValue}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc2x3tc1.IfcAppliedValue#getValuesReferenced Values Referenced}'.
	 * 
	 * 
	 * If the meaning of the 'Referencing Values' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Referencing Values' reference list.
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReferencesValueDocument_ReferencingValues()
	 * @see org.bimserver.models.ifc2x3tc1.IfcAppliedValue#getValuesReferenced
	 * @model opposite="ValuesReferenced"
	 * @generated
	 */
	EList getReferencingValues();

	/**
	 * 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 #isSetName()
	 * @see #unsetName()
	 * @see #setName(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReferencesValueDocument_Name()
	 * @model unsettable="true"
	 * @generated
	 */
	String getName();

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getName Name}' attribute.
	 * 
	 * 
	 * @see #isSetName()
	 * @see #getName()
	 * @see #setName(String)
	 * @generated
	 */
	void unsetName();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getName Name}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Name' attribute is set.
	 * @see #unsetName()
	 * @see #getName()
	 * @see #setName(String)
	 * @generated
	 */
	boolean isSetName();

	/**
	 * 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 #isSetDescription()
	 * @see #unsetDescription()
	 * @see #setDescription(String)
	 * @see org.bimserver.models.ifc2x3tc1.Ifc2x3tc1Package#getIfcReferencesValueDocument_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getDescription Description}' attribute.
	 * 
	 * 
	 * @see #isSetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	void unsetDescription();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc2x3tc1.IfcReferencesValueDocument#getDescription Description}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Description' attribute is set.
	 * @see #unsetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	boolean isSetDescription();

} // IfcReferencesValueDocument