org.bimserver.models.ifc4.IfcAddress Maven / Gradle / Ivy

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 Address'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcAddress#getPurpose Purpose}
 *   {@link org.bimserver.models.ifc4.IfcAddress#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcAddress#getUserDefinedPurpose User Defined Purpose}
 *   {@link org.bimserver.models.ifc4.IfcAddress#getOfPerson Of Person}
 *   {@link org.bimserver.models.ifc4.IfcAddress#getOfOrganization Of Organization}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAddress()
 * @model
 * @generated
 */
public interface IfcAddress extends IfcObjectReferenceSelect {
	/**
	 * Returns the value of the 'Purpose' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcAddressTypeEnum}.
	 * 
	 * 
	 * If the meaning of the 'Purpose' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Purpose' attribute.
	 * @see org.bimserver.models.ifc4.IfcAddressTypeEnum
	 * @see #isSetPurpose()
	 * @see #unsetPurpose()
	 * @see #setPurpose(IfcAddressTypeEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAddress_Purpose()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcAddressTypeEnum getPurpose();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getPurpose Purpose}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Purpose' attribute.
	 * @see org.bimserver.models.ifc4.IfcAddressTypeEnum
	 * @see #isSetPurpose()
	 * @see #unsetPurpose()
	 * @see #getPurpose()
	 * @generated
	 */
	void setPurpose(IfcAddressTypeEnum value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getPurpose Purpose}' attribute.
	 * 
	 * 
	 * @see #isSetPurpose()
	 * @see #getPurpose()
	 * @see #setPurpose(IfcAddressTypeEnum)
	 * @generated
	 */
	void unsetPurpose();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getPurpose Purpose}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Purpose' attribute is set.
	 * @see #unsetPurpose()
	 * @see #getPurpose()
	 * @see #setPurpose(IfcAddressTypeEnum)
	 * @generated
	 */
	boolean isSetPurpose();

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

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

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAddress#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 'User Defined Purpose' attribute.
	 * 
	 * 
	 * If the meaning of the 'User Defined Purpose' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'User Defined Purpose' attribute.
	 * @see #isSetUserDefinedPurpose()
	 * @see #unsetUserDefinedPurpose()
	 * @see #setUserDefinedPurpose(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAddress_UserDefinedPurpose()
	 * @model unsettable="true"
	 * @generated
	 */
	String getUserDefinedPurpose();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getUserDefinedPurpose User Defined Purpose}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'User Defined Purpose' attribute.
	 * @see #isSetUserDefinedPurpose()
	 * @see #unsetUserDefinedPurpose()
	 * @see #getUserDefinedPurpose()
	 * @generated
	 */
	void setUserDefinedPurpose(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getUserDefinedPurpose User Defined Purpose}' attribute.
	 * 
	 * 
	 * @see #isSetUserDefinedPurpose()
	 * @see #getUserDefinedPurpose()
	 * @see #setUserDefinedPurpose(String)
	 * @generated
	 */
	void unsetUserDefinedPurpose();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getUserDefinedPurpose User Defined Purpose}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'User Defined Purpose' attribute is set.
	 * @see #unsetUserDefinedPurpose()
	 * @see #getUserDefinedPurpose()
	 * @see #setUserDefinedPurpose(String)
	 * @generated
	 */
	boolean isSetUserDefinedPurpose();

	/**
	 * Returns the value of the 'Of Person' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcPerson}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcPerson#getAddresses Addresses}'.
	 * 
	 * 
	 * If the meaning of the 'Of Person' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Of Person' reference list.
	 * @see #isSetOfPerson()
	 * @see #unsetOfPerson()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAddress_OfPerson()
	 * @see org.bimserver.models.ifc4.IfcPerson#getAddresses
	 * @model opposite="Addresses" unsettable="true"
	 * @generated
	 */
	EList getOfPerson();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getOfPerson Of Person}' reference list.
	 * 
	 * 
	 * @see #isSetOfPerson()
	 * @see #getOfPerson()
	 * @generated
	 */
	void unsetOfPerson();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getOfPerson Of Person}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Of Person' reference list is set.
	 * @see #unsetOfPerson()
	 * @see #getOfPerson()
	 * @generated
	 */
	boolean isSetOfPerson();

	/**
	 * Returns the value of the 'Of Organization' reference list.
	 * The list contents are of type {@link org.bimserver.models.ifc4.IfcOrganization}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcOrganization#getAddresses Addresses}'.
	 * 
	 * 
	 * If the meaning of the 'Of Organization' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Of Organization' reference list.
	 * @see #isSetOfOrganization()
	 * @see #unsetOfOrganization()
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcAddress_OfOrganization()
	 * @see org.bimserver.models.ifc4.IfcOrganization#getAddresses
	 * @model opposite="Addresses" unsettable="true"
	 * @generated
	 */
	EList getOfOrganization();

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getOfOrganization Of Organization}' reference list.
	 * 
	 * 
	 * @see #isSetOfOrganization()
	 * @see #getOfOrganization()
	 * @generated
	 */
	void unsetOfOrganization();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcAddress#getOfOrganization Of Organization}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Of Organization' reference list is set.
	 * @see #unsetOfOrganization()
	 * @see #getOfOrganization()
	 * @generated
	 */
	boolean isSetOfOrganization();

} // IfcAddress