org.bimserver.models.ifc4.IfcObjectDefinition 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 Object Definition'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasAssignments Has Assignments}
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getNests Nests}
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getIsNestedBy Is Nested By}
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasContext Has Context}
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getIsDecomposedBy Is Decomposed By}
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getDecomposes Decomposes}
 *   {@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasAssociations Has Associations}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition()
 * @model
 * @generated
 */
public interface IfcObjectDefinition extends IfcRoot, IfcDefinitionSelect {
	/**
	 * Returns the value of the 'Has Assignments' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelAssigns}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelAssigns#getRelatedObjects Related Objects}'.
	 * 
	 * 
	 * If the meaning of the 'Has Assignments' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Assignments' reference list.
	 * @see #isSetHasAssignments()
	 * @see #unsetHasAssignments()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_HasAssignments()
	 * @see org.bimserver.models.ifc4.IfcRelAssigns#getRelatedObjects
	 * @model opposite="RelatedObjects" unsettable="true"
	 * @generated
	 */
	EList getHasAssignments();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasAssignments Has Assignments}' reference list.
	 * 
	 * 
	 * @see #isSetHasAssignments()
	 * @see #getHasAssignments()
	 * @generated
	 */
	void unsetHasAssignments();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasAssignments Has Assignments}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Assignments' reference list is set.
	 * @see #unsetHasAssignments()
	 * @see #getHasAssignments()
	 * @generated
	 */
	boolean isSetHasAssignments();

	/**
	 * Returns the value of the 'Nests' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelNests}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelNests#getRelatedObjects Related Objects}'.
	 * 
	 * 
	 * If the meaning of the 'Nests' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Nests' reference list.
	 * @see #isSetNests()
	 * @see #unsetNests()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_Nests()
	 * @see org.bimserver.models.ifc4.IfcRelNests#getRelatedObjects
	 * @model opposite="RelatedObjects" unsettable="true" upper="2"
	 * @generated
	 */
	EList getNests();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getNests Nests}' reference list.
	 * 
	 * 
	 * @see #isSetNests()
	 * @see #getNests()
	 * @generated
	 */
	void unsetNests();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getNests Nests}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Nests' reference list is set.
	 * @see #unsetNests()
	 * @see #getNests()
	 * @generated
	 */
	boolean isSetNests();

	/**
	 * Returns the value of the 'Is Nested By' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelNests}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelNests#getRelatingObject Relating Object}'.
	 * 
	 * 
	 * If the meaning of the 'Is Nested By' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Is Nested By' reference list.
	 * @see #isSetIsNestedBy()
	 * @see #unsetIsNestedBy()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_IsNestedBy()
	 * @see org.bimserver.models.ifc4.IfcRelNests#getRelatingObject
	 * @model opposite="RelatingObject" unsettable="true"
	 * @generated
	 */
	EList getIsNestedBy();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getIsNestedBy Is Nested By}' reference list.
	 * 
	 * 
	 * @see #isSetIsNestedBy()
	 * @see #getIsNestedBy()
	 * @generated
	 */
	void unsetIsNestedBy();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getIsNestedBy Is Nested By}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Is Nested By' reference list is set.
	 * @see #unsetIsNestedBy()
	 * @see #getIsNestedBy()
	 * @generated
	 */
	boolean isSetIsNestedBy();

	/**
	 * Returns the value of the 'Has Context' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelDeclares}.
	 * 
	 * 
	 * If the meaning of the 'Has Context' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Context' reference list.
	 * @see #isSetHasContext()
	 * @see #unsetHasContext()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_HasContext()
	 * @model unsettable="true" upper="2"
	 * @generated
	 */
	EList getHasContext();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasContext Has Context}' reference list.
	 * 
	 * 
	 * @see #isSetHasContext()
	 * @see #getHasContext()
	 * @generated
	 */
	void unsetHasContext();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasContext Has Context}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Context' reference list is set.
	 * @see #unsetHasContext()
	 * @see #getHasContext()
	 * @generated
	 */
	boolean isSetHasContext();

	/**
	 * Returns the value of the 'Is Decomposed By' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelAggregates}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelAggregates#getRelatingObject Relating Object}'.
	 * 
	 * 
	 * If the meaning of the 'Is Decomposed By' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Is Decomposed By' reference list.
	 * @see #isSetIsDecomposedBy()
	 * @see #unsetIsDecomposedBy()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_IsDecomposedBy()
	 * @see org.bimserver.models.ifc4.IfcRelAggregates#getRelatingObject
	 * @model opposite="RelatingObject" unsettable="true"
	 * @generated
	 */
	EList getIsDecomposedBy();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getIsDecomposedBy Is Decomposed By}' reference list.
	 * 
	 * 
	 * @see #isSetIsDecomposedBy()
	 * @see #getIsDecomposedBy()
	 * @generated
	 */
	void unsetIsDecomposedBy();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getIsDecomposedBy Is Decomposed By}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Is Decomposed By' reference list is set.
	 * @see #unsetIsDecomposedBy()
	 * @see #getIsDecomposedBy()
	 * @generated
	 */
	boolean isSetIsDecomposedBy();

	/**
	 * Returns the value of the 'Decomposes' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelAggregates}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelAggregates#getRelatedObjects Related Objects}'.
	 * 
	 * 
	 * If the meaning of the 'Decomposes' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Decomposes' reference list.
	 * @see #isSetDecomposes()
	 * @see #unsetDecomposes()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_Decomposes()
	 * @see org.bimserver.models.ifc4.IfcRelAggregates#getRelatedObjects
	 * @model opposite="RelatedObjects" unsettable="true" upper="2"
	 * @generated
	 */
	EList getDecomposes();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getDecomposes Decomposes}' reference list.
	 * 
	 * 
	 * @see #isSetDecomposes()
	 * @see #getDecomposes()
	 * @generated
	 */
	void unsetDecomposes();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getDecomposes Decomposes}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Decomposes' reference list is set.
	 * @see #unsetDecomposes()
	 * @see #getDecomposes()
	 * @generated
	 */
	boolean isSetDecomposes();

	/**
	 * Returns the value of the 'Has Associations' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelAssociates}.
	 * 
	 * 
	 * If the meaning of the 'Has Associations' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Associations' reference list.
	 * @see #isSetHasAssociations()
	 * @see #unsetHasAssociations()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcObjectDefinition_HasAssociations()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getHasAssociations();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasAssociations Has Associations}' reference list.
	 * 
	 * 
	 * @see #isSetHasAssociations()
	 * @see #getHasAssociations()
	 * @generated
	 */
	void unsetHasAssociations();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcObjectDefinition#getHasAssociations Has Associations}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has Associations' reference list is set.
	 * @see #unsetHasAssociations()
	 * @see #getHasAssociations()
	 * @generated
	 */
	boolean isSetHasAssociations();

} // IfcObjectDefinition