Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db.management / src / org / simantics / db / management / ISessionContextProvider.java

diff --git a/bundles/org.simantics.db.management/src/org/simantics/db/management/ISessionContextProvider.java b/bundles/org.simantics.db.management/src/org/simantics/db/management/ISessionContextProvider.java
new file mode 100644 (file)
index 0000000..8d33252
--- /dev/null
+++ b/bundles/org.simantics.db.management/src/org/simantics/db/management/ISessionContextProvider.java
@@ -0,0 +1,57 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2011 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.db.management;\r
+\r
+/**\r
+ * @see ISessionContextChangedListener\r
+ * @see SessionContextChangedEvent\r
+ * @see ISessionContext\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface ISessionContextProvider {\r
+\r
+    /**\r
+     * Adds a listener for selection changes in this selection provider.\r
+     * Has no effect if an identical listener is already registered.\r
+     *\r
+     * @param listener a session context changed listener\r
+     */\r
+    public void addContextChangedListener(ISessionContextChangedListener listener);\r
+\r
+    /**\r
+     * Returns the current selection for this provider.\r
+     * \r
+     * @return the current session context\r
+     */\r
+    public ISessionContext getSessionContext();\r
+\r
+    /**\r
+     * Removes the given selection change listener from this selection provider.\r
+     * Has no affect if an identical listener is not registered.\r
+     *\r
+     * @param listener a session context changed listener\r
+     */\r
+    public void removeContextChangedListener(ISessionContextChangedListener listener);\r
+\r
+    /**\r
+     * Sets the current selection for this selection provider. The operation\r
+     * must only fire {@link ISessionContextChangedListener}s if the\r
+     * ISessionContext actually changed in the {@link #equals(Object)} sense.\r
+     * \r
+     * @param context the new session context\r
+     * @return the old ISessionContext or <code>null</code> there was no\r
+     *         previous context\r
+     */\r
+    public ISessionContext setSessionContext(ISessionContext context);\r
+\r
+}\r