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

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

/**
 * 
 * A representation of the model object 'Ifc Constraint'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getName Name}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getConstraintGrade Constraint Grade}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getConstraintSource Constraint Source}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getCreatingActor Creating Actor}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getCreationTime Creation Time}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getUserDefinedGrade User Defined Grade}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getHasExternalReferences Has External References}
 *   {@link org.bimserver.models.ifc4.IfcConstraint#getPropertiesForConstraint Properties For Constraint}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint()
 * @model
 * @generated
 */
public interface IfcConstraint extends IfcResourceObjectSelect {
	/**
	 * 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 #setName(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_Name()
	 * @model
	 * @generated
	 */
	String getName();

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

	/**
	 * 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#getIfcConstraint_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

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

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#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 'Constraint Grade' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcConstraintEnum}.
	 * 
	 * 
	 * If the meaning of the 'Constraint Grade' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Constraint Grade' attribute.
	 * @see org.bimserver.models.ifc4.IfcConstraintEnum
	 * @see #setConstraintGrade(IfcConstraintEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_ConstraintGrade()
	 * @model
	 * @generated
	 */
	IfcConstraintEnum getConstraintGrade();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getConstraintGrade Constraint Grade}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Constraint Grade' attribute.
	 * @see org.bimserver.models.ifc4.IfcConstraintEnum
	 * @see #getConstraintGrade()
	 * @generated
	 */
	void setConstraintGrade(IfcConstraintEnum value);

	/**
	 * Returns the value of the 'Constraint Source' attribute.
	 * 
	 * 
	 * If the meaning of the 'Constraint Source' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Constraint Source' attribute.
	 * @see #isSetConstraintSource()
	 * @see #unsetConstraintSource()
	 * @see #setConstraintSource(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_ConstraintSource()
	 * @model unsettable="true"
	 * @generated
	 */
	String getConstraintSource();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getConstraintSource Constraint Source}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Constraint Source' attribute.
	 * @see #isSetConstraintSource()
	 * @see #unsetConstraintSource()
	 * @see #getConstraintSource()
	 * @generated
	 */
	void setConstraintSource(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getConstraintSource Constraint Source}' attribute.
	 * 
	 * 
	 * @see #isSetConstraintSource()
	 * @see #getConstraintSource()
	 * @see #setConstraintSource(String)
	 * @generated
	 */
	void unsetConstraintSource();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getConstraintSource Constraint Source}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Constraint Source' attribute is set.
	 * @see #unsetConstraintSource()
	 * @see #getConstraintSource()
	 * @see #setConstraintSource(String)
	 * @generated
	 */
	boolean isSetConstraintSource();

	/**
	 * Returns the value of the 'Creating Actor' reference.
	 * 
	 * 
	 * If the meaning of the 'Creating Actor' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Creating Actor' reference.
	 * @see #isSetCreatingActor()
	 * @see #unsetCreatingActor()
	 * @see #setCreatingActor(IfcActorSelect)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_CreatingActor()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcActorSelect getCreatingActor();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getCreatingActor Creating Actor}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Creating Actor' reference.
	 * @see #isSetCreatingActor()
	 * @see #unsetCreatingActor()
	 * @see #getCreatingActor()
	 * @generated
	 */
	void setCreatingActor(IfcActorSelect value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getCreatingActor Creating Actor}' reference.
	 * 
	 * 
	 * @see #isSetCreatingActor()
	 * @see #getCreatingActor()
	 * @see #setCreatingActor(IfcActorSelect)
	 * @generated
	 */
	void unsetCreatingActor();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getCreatingActor Creating Actor}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Creating Actor' reference is set.
	 * @see #unsetCreatingActor()
	 * @see #getCreatingActor()
	 * @see #setCreatingActor(IfcActorSelect)
	 * @generated
	 */
	boolean isSetCreatingActor();

	/**
	 * Returns the value of the 'Creation Time' attribute.
	 * 
	 * 
	 * If the meaning of the 'Creation Time' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Creation Time' attribute.
	 * @see #isSetCreationTime()
	 * @see #unsetCreationTime()
	 * @see #setCreationTime(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_CreationTime()
	 * @model unsettable="true"
	 * @generated
	 */
	String getCreationTime();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getCreationTime Creation Time}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Creation Time' attribute.
	 * @see #isSetCreationTime()
	 * @see #unsetCreationTime()
	 * @see #getCreationTime()
	 * @generated
	 */
	void setCreationTime(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getCreationTime Creation Time}' attribute.
	 * 
	 * 
	 * @see #isSetCreationTime()
	 * @see #getCreationTime()
	 * @see #setCreationTime(String)
	 * @generated
	 */
	void unsetCreationTime();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getCreationTime Creation Time}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Creation Time' attribute is set.
	 * @see #unsetCreationTime()
	 * @see #getCreationTime()
	 * @see #setCreationTime(String)
	 * @generated
	 */
	boolean isSetCreationTime();

	/**
	 * Returns the value of the 'User Defined Grade' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Grade' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Grade' attribute.
	 * @see #isSetUserDefinedGrade()
	 * @see #unsetUserDefinedGrade()
	 * @see #setUserDefinedGrade(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_UserDefinedGrade()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedGrade();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getUserDefinedGrade User Defined Grade}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Grade' attribute.
	 * @see #isSetUserDefinedGrade()
	 * @see #unsetUserDefinedGrade()
	 * @see #getUserDefinedGrade()
	 * @generated
	 */
	void setUserDefinedGrade(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getUserDefinedGrade User Defined Grade}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedGrade()
	 * @see #getUserDefinedGrade()
	 * @see #setUserDefinedGrade(String)
	 * @generated
	 */
	void unsetUserDefinedGrade();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getUserDefinedGrade User Defined Grade}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Grade' attribute is set.
	 * @see #unsetUserDefinedGrade()
	 * @see #getUserDefinedGrade()
	 * @see #setUserDefinedGrade(String)
	 * @generated
	 */
	boolean isSetUserDefinedGrade();

	/**
	 * Returns the value of the 'Has External References' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcExternalReferenceRelationship}.
	 * 
	 * 
	 * If the meaning of the 'Has External References' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has External References' reference list.
	 * @see #isSetHasExternalReferences()
	 * @see #unsetHasExternalReferences()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_HasExternalReferences()
	 * @model unsettable="true"
	 * @generated
	 */
	EList getHasExternalReferences();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getHasExternalReferences Has External References}' reference list.
	 * 
	 * 
	 * @see #isSetHasExternalReferences()
	 * @see #getHasExternalReferences()
	 * @generated
	 */
	void unsetHasExternalReferences();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getHasExternalReferences Has External References}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Has External References' reference list is set.
	 * @see #unsetHasExternalReferences()
	 * @see #getHasExternalReferences()
	 * @generated
	 */
	boolean isSetHasExternalReferences();

	/**
	 * Returns the value of the 'Properties For Constraint' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcResourceConstraintRelationship}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcResourceConstraintRelationship#getRelatingConstraint Relating Constraint}'.
	 * 
	 * 
	 * If the meaning of the 'Properties For Constraint' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Properties For Constraint' reference list.
	 * @see #isSetPropertiesForConstraint()
	 * @see #unsetPropertiesForConstraint()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcConstraint_PropertiesForConstraint()
	 * @see org.bimserver.models.ifc4.IfcResourceConstraintRelationship#getRelatingConstraint
	 * @model opposite="RelatingConstraint" unsettable="true"
	 * @generated
	 */
	EList getPropertiesForConstraint();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getPropertiesForConstraint Properties For Constraint}' reference list.
	 * 
	 * 
	 * @see #isSetPropertiesForConstraint()
	 * @see #getPropertiesForConstraint()
	 * @generated
	 */
	void unsetPropertiesForConstraint();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcConstraint#getPropertiesForConstraint Properties For Constraint}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Properties For Constraint' reference list is set.
	 * @see #unsetPropertiesForConstraint()
	 * @see #getPropertiesForConstraint()
	 * @generated
	 */
	boolean isSetPropertiesForConstraint();

} // IfcConstraint