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

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

/**
 * 
 * A representation of the model object 'User Settings'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.store.UserSettings#getSerializers Serializers}
 *   {@link org.bimserver.models.store.UserSettings#getObjectIDMs Object ID Ms}
 *   {@link org.bimserver.models.store.UserSettings#getRenderEngines Render Engines}
 *   {@link org.bimserver.models.store.UserSettings#getDeserializers Deserializers}
 *   {@link org.bimserver.models.store.UserSettings#getQueryEngines Query Engines}
 *   {@link org.bimserver.models.store.UserSettings#getModelMergers Model Mergers}
 *   {@link org.bimserver.models.store.UserSettings#getModelCompares Model Compares}
 *   {@link org.bimserver.models.store.UserSettings#getDefaultModelMerger Default Model Merger}
 *   {@link org.bimserver.models.store.UserSettings#getDefaultModelCompare Default Model Compare}
 *   {@link org.bimserver.models.store.UserSettings#getDefaultQueryEngine Default Query Engine}
 *   {@link org.bimserver.models.store.UserSettings#getDefaultRenderEngine Default Render Engine}
 *   {@link org.bimserver.models.store.UserSettings#getDefaultSerializer Default Serializer}
 *   {@link org.bimserver.models.store.UserSettings#getDefaultObjectIDM Default Object IDM}
 *   {@link org.bimserver.models.store.UserSettings#getServices Services}
 *   {@link org.bimserver.models.store.UserSettings#getMessagingSerializerPlugins Messaging Serializer Plugins}
 * 
 *
 * @see org.bimserver.models.store.StorePackage#getUserSettings()
 * @model
 * @extends IdEObject
 * @generated
 */
public interface UserSettings extends IdEObject {
	/**
	 * Returns the value of the 'Serializers' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.SerializerPluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.SerializerPluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Serializers' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Serializers' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_Serializers()
	 * @see org.bimserver.models.store.SerializerPluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getSerializers();

	/**
	 * Returns the value of the 'Object ID Ms' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.ObjectIDMPluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.ObjectIDMPluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Object ID Ms' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Object ID Ms' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_ObjectIDMs()
	 * @see org.bimserver.models.store.ObjectIDMPluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getObjectIDMs();

	/**
	 * Returns the value of the 'Render Engines' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.RenderEnginePluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.RenderEnginePluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Render Engines' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Render Engines' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_RenderEngines()
	 * @see org.bimserver.models.store.RenderEnginePluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getRenderEngines();

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

	/**
	 * Returns the value of the 'Query Engines' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.QueryEnginePluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.QueryEnginePluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Query Engines' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Query Engines' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_QueryEngines()
	 * @see org.bimserver.models.store.QueryEnginePluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getQueryEngines();

	/**
	 * Returns the value of the 'Model Mergers' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.ModelMergerPluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.ModelMergerPluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Model Mergers' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Model Mergers' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_ModelMergers()
	 * @see org.bimserver.models.store.ModelMergerPluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getModelMergers();

	/**
	 * Returns the value of the 'Model Compares' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.ModelComparePluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.ModelComparePluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Model Compares' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Model Compares' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_ModelCompares()
	 * @see org.bimserver.models.store.ModelComparePluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getModelCompares();

	/**
	 * Returns the value of the 'Default Model Merger' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Model Merger' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Model Merger' reference.
	 * @see #setDefaultModelMerger(ModelMergerPluginConfiguration)
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_DefaultModelMerger()
	 * @model
	 * @generated
	 */
	ModelMergerPluginConfiguration getDefaultModelMerger();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSettings#getDefaultModelMerger Default Model Merger}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Model Merger' reference.
	 * @see #getDefaultModelMerger()
	 * @generated
	 */
	void setDefaultModelMerger(ModelMergerPluginConfiguration value);

	/**
	 * Returns the value of the 'Default Model Compare' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Model Compare' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Model Compare' reference.
	 * @see #setDefaultModelCompare(ModelComparePluginConfiguration)
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_DefaultModelCompare()
	 * @model
	 * @generated
	 */
	ModelComparePluginConfiguration getDefaultModelCompare();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSettings#getDefaultModelCompare Default Model Compare}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Model Compare' reference.
	 * @see #getDefaultModelCompare()
	 * @generated
	 */
	void setDefaultModelCompare(ModelComparePluginConfiguration value);

	/**
	 * Returns the value of the 'Default Query Engine' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Query Engine' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Query Engine' reference.
	 * @see #setDefaultQueryEngine(QueryEnginePluginConfiguration)
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_DefaultQueryEngine()
	 * @model
	 * @generated
	 */
	QueryEnginePluginConfiguration getDefaultQueryEngine();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSettings#getDefaultQueryEngine Default Query Engine}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Query Engine' reference.
	 * @see #getDefaultQueryEngine()
	 * @generated
	 */
	void setDefaultQueryEngine(QueryEnginePluginConfiguration value);

	/**
	 * Returns the value of the 'Default Render Engine' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Render Engine' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Render Engine' reference.
	 * @see #setDefaultRenderEngine(RenderEnginePluginConfiguration)
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_DefaultRenderEngine()
	 * @model
	 * @generated
	 */
	RenderEnginePluginConfiguration getDefaultRenderEngine();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSettings#getDefaultRenderEngine Default Render Engine}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Render Engine' reference.
	 * @see #getDefaultRenderEngine()
	 * @generated
	 */
	void setDefaultRenderEngine(RenderEnginePluginConfiguration value);

	/**
	 * Returns the value of the 'Default Serializer' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Serializer' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Serializer' reference.
	 * @see #setDefaultSerializer(SerializerPluginConfiguration)
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_DefaultSerializer()
	 * @model
	 * @generated
	 */
	SerializerPluginConfiguration getDefaultSerializer();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSettings#getDefaultSerializer Default Serializer}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Serializer' reference.
	 * @see #getDefaultSerializer()
	 * @generated
	 */
	void setDefaultSerializer(SerializerPluginConfiguration value);

	/**
	 * Returns the value of the 'Default Object IDM' reference.
	 * 
	 * 
	 * If the meaning of the 'Default Object IDM' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Default Object IDM' reference.
	 * @see #setDefaultObjectIDM(ObjectIDMPluginConfiguration)
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_DefaultObjectIDM()
	 * @model
	 * @generated
	 */
	ObjectIDMPluginConfiguration getDefaultObjectIDM();

	/**
	 * Sets the value of the '{@link org.bimserver.models.store.UserSettings#getDefaultObjectIDM Default Object IDM}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Default Object IDM' reference.
	 * @see #getDefaultObjectIDM()
	 * @generated
	 */
	void setDefaultObjectIDM(ObjectIDMPluginConfiguration value);

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

	/**
	 * Returns the value of the 'Messaging Serializer Plugins' reference list.
	 * The list contents are of type {@link org.bimserver.models.store.MessagingSerializerPluginConfiguration}.
	 * It is bidirectional and its opposite is '{@link org.bimserver.models.store.MessagingSerializerPluginConfiguration#getUserSettings User Settings}'.
	 * 
	 * 
	 * If the meaning of the 'Messaging Serializer Plugins' reference list isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Messaging Serializer Plugins' reference list.
	 * @see org.bimserver.models.store.StorePackage#getUserSettings_MessagingSerializerPlugins()
	 * @see org.bimserver.models.store.MessagingSerializerPluginConfiguration#getUserSettings
	 * @model opposite="userSettings"
	 * @generated
	 */
	EList getMessagingSerializerPlugins();

} // UserSettings