org.bimserver.models.ifc4.IfcLibraryReference 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 Library Reference'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcLibraryReference#getDescription Description}
 *   {@link org.bimserver.models.ifc4.IfcLibraryReference#getLanguage Language}
 *   {@link org.bimserver.models.ifc4.IfcLibraryReference#getReferencedLibrary Referenced Library}
 *   {@link org.bimserver.models.ifc4.IfcLibraryReference#getLibraryRefForObjects Library Ref For Objects}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLibraryReference()
 * @model
 * @generated
 */
public interface IfcLibraryReference extends IfcExternalReference, IfcLibrarySelect {
	/**
	 * 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#getIfcLibraryReference_Description()
	 * @model unsettable="true"
	 * @generated
	 */
	String getDescription();

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

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#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 'Language' attribute.
	 * 
	 * 
	 * If the meaning of the 'Language' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Language' attribute.
	 * @see #isSetLanguage()
	 * @see #unsetLanguage()
	 * @see #setLanguage(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLibraryReference_Language()
	 * @model unsettable="true"
	 * @generated
	 */
	String getLanguage();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getLanguage Language}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Language' attribute.
	 * @see #isSetLanguage()
	 * @see #unsetLanguage()
	 * @see #getLanguage()
	 * @generated
	 */
	void setLanguage(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getLanguage Language}' attribute.
	 * 
	 * 
	 * @see #isSetLanguage()
	 * @see #getLanguage()
	 * @see #setLanguage(String)
	 * @generated
	 */
	void unsetLanguage();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getLanguage Language}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Language' attribute is set.
	 * @see #unsetLanguage()
	 * @see #getLanguage()
	 * @see #setLanguage(String)
	 * @generated
	 */
	boolean isSetLanguage();

	/**
	 * Returns the value of the 'Referenced Library' reference.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.ifc4.IfcLibraryInformation#getHasLibraryReferences Has Library References}'.
	 * 
	 * 
	 * If the meaning of the 'Referenced Library' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Referenced Library' reference.
	 * @see #isSetReferencedLibrary()
	 * @see #unsetReferencedLibrary()
	 * @see #setReferencedLibrary(IfcLibraryInformation)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcLibraryReference_ReferencedLibrary()
	 * @see org.bimserver.models.ifc4.IfcLibraryInformation#getHasLibraryReferences
	 * @model opposite="HasLibraryReferences" unsettable="true"
	 * @generated
	 */
	IfcLibraryInformation getReferencedLibrary();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getReferencedLibrary Referenced Library}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Referenced Library' reference.
	 * @see #isSetReferencedLibrary()
	 * @see #unsetReferencedLibrary()
	 * @see #getReferencedLibrary()
	 * @generated
	 */
	void setReferencedLibrary(IfcLibraryInformation value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getReferencedLibrary Referenced Library}' reference.
	 * 
	 * 
	 * @see #isSetReferencedLibrary()
	 * @see #getReferencedLibrary()
	 * @see #setReferencedLibrary(IfcLibraryInformation)
	 * @generated
	 */
	void unsetReferencedLibrary();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getReferencedLibrary Referenced Library}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Referenced Library' reference is set.
	 * @see #unsetReferencedLibrary()
	 * @see #getReferencedLibrary()
	 * @see #setReferencedLibrary(IfcLibraryInformation)
	 * @generated
	 */
	boolean isSetReferencedLibrary();

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

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getLibraryRefForObjects Library Ref For Objects}' reference list.
	 * 
	 * 
	 * @see #isSetLibraryRefForObjects()
	 * @see #getLibraryRefForObjects()
	 * @generated
	 */
	void unsetLibraryRefForObjects();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcLibraryReference#getLibraryRefForObjects Library Ref For Objects}' reference list is set.
	 * 
	 * 
	 * @return whether the value of the 'Library Ref For Objects' reference list is set.
	 * @see #unsetLibraryRefForObjects()
	 * @see #getLibraryRefForObjects()
	 * @generated
	 */
	boolean isSetLibraryRefForObjects();

} // IfcLibraryReference