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

import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'Ifc Document Reference'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcDocumentReference#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcDocumentReference#getReferencedDocument Referenced Document}
 *   {@link org.bimserver.models.ifc4.IfcDocumentReference#getDocumentRefForObjects Document Ref For Objects}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDocumentReference()
 * @model
 * @generated
 */
public interface IfcDocumentReference extends IfcExternalReference, IfcDocumentSelect {
	/**
	 * 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.ifc4.Ifc4Package#getIfcDocumentReference_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#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.ifc4.IfcDocumentReference#getDescription Description}' attribute.
	 * 
	 * 
	 * @see #isSetDescription()
	 * @see #getDescription()
	 * @see #setDescription(String)
	 * @generated
	 */
	void unsetDescription();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#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();

	/**
	 * Returns the value of the 'Referenced Document' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcDocumentInformation#getHasDocumentReferences Has Document References}'.
	 * 
	 * 
	 * 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 #isSetReferencedDocument()
	 * @see #unsetReferencedDocument()
	 * @see #setReferencedDocument(IfcDocumentInformation)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDocumentReference_ReferencedDocument()
	 * @see org.bimserver.models.ifc4.IfcDocumentInformation#getHasDocumentReferences
	 * @model opposite="HasDocumentReferences" unsettable="true"
	 * @generated
	 */
	IfcDocumentInformation getReferencedDocument();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#getReferencedDocument Referenced Document}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Referenced Document' reference.
	 * @see #isSetReferencedDocument()
	 * @see #unsetReferencedDocument()
	 * @see #getReferencedDocument()
	 * @generated
	 */
	void setReferencedDocument(IfcDocumentInformation value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#getReferencedDocument Referenced Document}' reference.
	 * 
	 * 
	 * @see #isSetReferencedDocument()
	 * @see #getReferencedDocument()
	 * @see #setReferencedDocument(IfcDocumentInformation)
	 * @generated
	 */
	void unsetReferencedDocument();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#getReferencedDocument Referenced Document}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Referenced Document' reference is set.
	 * @see #unsetReferencedDocument()
	 * @see #getReferencedDocument()
	 * @see #setReferencedDocument(IfcDocumentInformation)
	 * @generated
	 */
	boolean isSetReferencedDocument();

	/**
	 * Returns the value of the 'Document Ref For Objects' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelAssociatesDocument}.
	 * 
	 * 
	 * If the meaning of the 'Document Ref For Objects' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Document Ref For Objects' reference list.
	 * @see #isSetDocumentRefForObjects()
	 * @see #unsetDocumentRefForObjects()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcDocumentReference_DocumentRefForObjects()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getDocumentRefForObjects();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#getDocumentRefForObjects Document Ref For Objects}' reference list.
	 * 
	 * 
	 * @see #isSetDocumentRefForObjects()
	 * @see #getDocumentRefForObjects()
	 * @generated
	 */
	void unsetDocumentRefForObjects();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcDocumentReference#getDocumentRefForObjects Document Ref For Objects}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Document Ref For Objects' reference list is set.
	 * @see #unsetDocumentRefForObjects()
	 * @see #getDocumentRefForObjects()
	 * @generated
	 */
	boolean isSetDocumentRefForObjects();

} // IfcDocumentReference