--- /dev/null
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 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.layer0.genericrelation;\r
+\r
+import java.util.Collection;\r
+import java.util.List;\r
+import java.util.Map;\r
+\r
+import org.eclipse.core.runtime.IProgressMonitor;\r
+import org.simantics.db.RequestProcessor;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.layer0.adapter.GenericRelation;\r
+\r
+/**\r
+ * TODO: how to use\r
+ * \r
+ * TODO: make a statement about synchronization requirements imposed by the interface\r
+ * \r
+ * TODO: what exceptions are the methods supposed to throw? any checked exceptions?\r
+ * \r
+ * @author Antti Villberg\r
+ */\r
+public interface IndexedRelations {\r
+\r
+ /**\r
+ * @param monitor\r
+ * @param search\r
+ * @param session\r
+ * @param relation\r
+ * @param input\r
+ * @param maxResultCount\r
+ * @return\r
+ * @throws IndexException\r
+ */\r
+ public List<Map<String, Object>> query(IProgressMonitor monitor, String search, RequestProcessor session,\r
+ Resource relation, Resource input, int maxResultCount) throws IndexException;\r
+\r
+ public List<Resource> queryResources(IProgressMonitor monitor, String search, RequestProcessor session,\r
+ Resource relation, Resource input, int maxResultCount) throws IndexException;\r
+\r
+ /**\r
+ * @param monitor\r
+ * @param processor\r
+ * @param relation\r
+ * @param resource\r
+ * @param input\r
+ * @param documents\r
+ * @throws IndexException\r
+ */\r
+ public void insert(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
+ Resource resource, Resource input, Collection<Object[]> documents)\r
+ throws IndexException;\r
+\r
+ /**\r
+ * @param monitor\r
+ * @param processor\r
+ * @param relation\r
+ * @param resource\r
+ * @param input\r
+ * @param key\r
+ * @param keyValues\r
+ * @throws IndexException\r
+ */\r
+ public void remove(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
+ Resource resource, Resource input, String key, Collection<Object> keyValues)\r
+ throws IndexException;\r
+\r
+ public void removeAll(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
+ Resource resource, Resource input)\r
+ throws IndexException;\r
+ \r
+ /**\r
+ * @param monitor\r
+ * @param processor\r
+ * @param relation\r
+ * @param resource\r
+ * @param input\r
+ * @param key\r
+ * @param keyValues\r
+ * @param documents\r
+ * @throws IndexException\r
+ */\r
+ public boolean replace(IProgressMonitor monitor, RequestProcessor processor, GenericRelation relation,\r
+ Resource resource, Resource input, String key, Collection<Object> keyValues, Collection<Object[]> documents)\r
+ throws IndexException;\r
+\r
+ public void reset(IProgressMonitor monitor, RequestProcessor processor, Resource resource, Resource input)\r
+ throws IndexException;\r
+\r
+}\r