org.bimserver.models.ifc4.IfcPropertySetTemplate 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 Property Set Template'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getTemplateType Template Type}
 *   {@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getApplicableEntity Applicable Entity}
 *   {@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getHasPropertyTemplates Has Property Templates}
 *   {@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getDefines Defines}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPropertySetTemplate()
 * @model
 * @generated
 */
public interface IfcPropertySetTemplate extends IfcPropertyTemplateDefinition {
	/**
	 * Returns the value of the 'Template Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcPropertySetTemplateTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Template Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Template Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcPropertySetTemplateTypeEnum
	 * @see #isSetTemplateType()
	 * @see #unsetTemplateType()
	 * @see #setTemplateType(IfcPropertySetTemplateTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPropertySetTemplate_TemplateType()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcPropertySetTemplateTypeEnum getTemplateType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getTemplateType Template Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Template Type' attribute.
	 * @see org.bimserver.models.ifc4.IfcPropertySetTemplateTypeEnum
	 * @see #isSetTemplateType()
	 * @see #unsetTemplateType()
	 * @see #getTemplateType()
	 * @generated
	 */
	void setTemplateType(IfcPropertySetTemplateTypeEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getTemplateType Template Type}' attribute.
	 * 
	 * 
	 * @see #isSetTemplateType()
	 * @see #getTemplateType()
	 * @see #setTemplateType(IfcPropertySetTemplateTypeEnum)
	 * @generated
	 */
	void unsetTemplateType();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getTemplateType Template Type}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Template Type' attribute is set.
	 * @see #unsetTemplateType()
	 * @see #getTemplateType()
	 * @see #setTemplateType(IfcPropertySetTemplateTypeEnum)
	 * @generated
	 */
	boolean isSetTemplateType();

	/**
	 * Returns the value of the 'Applicable Entity' attribute.
	 * 
	 * 
	 * If the meaning of the 'Applicable Entity' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Applicable Entity' attribute.
	 * @see #isSetApplicableEntity()
	 * @see #unsetApplicableEntity()
	 * @see #setApplicableEntity(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPropertySetTemplate_ApplicableEntity()
	 * @model unsettable="true"
	 * @generated
	 */
	String getApplicableEntity();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getApplicableEntity Applicable Entity}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Applicable Entity' attribute.
	 * @see #isSetApplicableEntity()
	 * @see #unsetApplicableEntity()
	 * @see #getApplicableEntity()
	 * @generated
	 */
	void setApplicableEntity(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getApplicableEntity Applicable Entity}' attribute.
	 * 
	 * 
	 * @see #isSetApplicableEntity()
	 * @see #getApplicableEntity()
	 * @see #setApplicableEntity(String)
	 * @generated
	 */
	void unsetApplicableEntity();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getApplicableEntity Applicable Entity}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Applicable Entity' attribute is set.
	 * @see #unsetApplicableEntity()
	 * @see #getApplicableEntity()
	 * @see #setApplicableEntity(String)
	 * @generated
	 */
	boolean isSetApplicableEntity();

	/**
	 * Returns the value of the 'Has Property Templates' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcPropertyTemplate}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPropertyTemplate#getPartOfPsetTemplate Part Of Pset Template}'.
	 * 
	 * 
	 * If the meaning of the 'Has Property Templates' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Has Property Templates' reference list.
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPropertySetTemplate_HasPropertyTemplates()
	 * @see org.bimserver.models.ifc4.IfcPropertyTemplate#getPartOfPsetTemplate
	 * @model opposite="PartOfPsetTemplate"
	 * @generated
	 */
	EList getHasPropertyTemplates();

	/**
	 * Returns the value of the 'Defines' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcRelDefinesByTemplate}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcRelDefinesByTemplate#getRelatingTemplate Relating Template}'.
	 * 
	 * 
	 * If the meaning of the 'Defines' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Defines' reference list.
	 * @see #isSetDefines()
	 * @see #unsetDefines()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcPropertySetTemplate_Defines()
	 * @see org.bimserver.models.ifc4.IfcRelDefinesByTemplate#getRelatingTemplate
	 * @model opposite="RelatingTemplate" unsettable="true"
	 * @generated
	 */
	EList getDefines();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getDefines Defines}' reference list.
	 * 
	 * 
	 * @see #isSetDefines()
	 * @see #getDefines()
	 * @generated
	 */
	void unsetDefines();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcPropertySetTemplate#getDefines Defines}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Defines' reference list is set.
	 * @see #unsetDefines()
	 * @see #getDefines()
	 * @generated
	 */
	boolean isSetDefines();

} // IfcPropertySetTemplate