org.bimserver.models.store.ExtendedDataSchema 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.store;

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

/**
 * 
 * A representation of the model object 'Extended Data Schema'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getName Name}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getUrl Url}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getNamespace Namespace}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getDescription Description}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getFile File}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getSize Size}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#isValidate Validate}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getType Type}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getUsers Users}
 *   {@link org.bimserver.models.store.ExtendedDataSchema#getExtendedData Extended Data}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface ExtendedDataSchema extends IdEObject {
	/**
	 * 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.store.StorePackage#getExtendedDataSchema_Name()
	 * @model
	 * @generated
	 */
	String getName();

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

	/**
	 * Returns the value of the 'Url' attribute.
	 * 
	 * 
	 * If the meaning of the 'Url' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Url' attribute.
	 * @see #setUrl(String)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Url()
	 * @model
	 * @generated
	 */
	String getUrl();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#getUrl Url}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Url' attribute.
	 * @see #getUrl()
	 * @generated
	 */
	void setUrl(String value);

	/**
	 * Returns the value of the 'Namespace' attribute.
	 * 
	 * 
	 * If the meaning of the 'Namespace' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Namespace' attribute.
	 * @see #setNamespace(String)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Namespace()
	 * @model
	 * @generated
	 */
	String getNamespace();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#getNamespace Namespace}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Namespace' attribute.
	 * @see #getNamespace()
	 * @generated
	 */
	void setNamespace(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 #setDescription(String)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Description()
	 * @model
	 * @generated
	 */
	String getDescription();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#getDescription Description}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Description' attribute.
	 * @see #getDescription()
	 * @generated
	 */
	void setDescription(String value);

	/**
	 * Returns the value of the 'File' reference.
	 * 
	 * 
	 * If the meaning of the 'File' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'File' reference.
	 * @see #setFile(File)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_File()
	 * @model
	 * @generated
	 */
	File getFile();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#getFile File}' reference.
	 * 
	 * 
	 * @param value the new value of the 'File' reference.
	 * @see #getFile()
	 * @generated
	 */
	void setFile(File value);

	/**
	 * Returns the value of the 'Size' attribute.
	 * 
	 * 
	 * If the meaning of the 'Size' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Size' attribute.
	 * @see #setSize(long)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Size()
	 * @model
	 * @generated
	 */
	long getSize();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#getSize Size}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Size' attribute.
	 * @see #getSize()
	 * @generated
	 */
	void setSize(long value);

	/**
	 * Returns the value of the 'Validate' attribute.
	 * 
	 * 
	 * If the meaning of the 'Validate' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Validate' attribute.
	 * @see #setValidate(boolean)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Validate()
	 * @model
	 * @generated
	 */
	boolean isValidate();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#isValidate Validate}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Validate' attribute.
	 * @see #isValidate()
	 * @generated
	 */
	void setValidate(boolean value);

	/**
	 * Returns the value of the 'Type' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.store.ExtendedDataSchemaType}.
	 * 
	 * 
	 * If the meaning of the 'Type' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Type' attribute.
	 * @see org.bimserver.models.store.ExtendedDataSchemaType
	 * @see #setType(ExtendedDataSchemaType)
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Type()
	 * @model
	 * @generated
	 */
	ExtendedDataSchemaType getType();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.ExtendedDataSchema#getType Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Type' attribute.
	 * @see org.bimserver.models.store.ExtendedDataSchemaType
	 * @see #getType()
	 * @generated
	 */
	void setType(ExtendedDataSchemaType value);

	/**
	 * Returns the value of the 'Users' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.User}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.User#getSchemas Schemas}'.
	 * 
	 * 
	 * If the meaning of the 'Users' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Users' reference list.
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_Users()
	 * @see org.bimserver.models.store.User#getSchemas
	 * @model opposite="schemas"
	 * @generated
	 */
	EList getUsers();

	/**
	 * Returns the value of the 'Extended Data' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.ExtendedData}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.ExtendedData#getSchema Schema}'.
	 * 
	 * 
	 * If the meaning of the 'Extended Data' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Extended Data' reference list.
	 * @see org.bimserver.models.store.StorePackage#getExtendedDataSchema_ExtendedData()
	 * @see org.bimserver.models.store.ExtendedData#getSchema
	 * @model opposite="schema"
	 * @generated
	 */
	EList getExtendedData();

} // ExtendedDataSchema