Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / real-world application / MyDerby-10.3 / java / engine / org / apache / derby / iapi / sql / execute / CursorResultSet.java
diff --git a/JMCR-Stable/real-world application/MyDerby-10.3/java/engine/org/apache/derby/iapi/sql/execute/CursorResultSet.java b/JMCR-Stable/real-world application/MyDerby-10.3/java/engine/org/apache/derby/iapi/sql/execute/CursorResultSet.java
new file mode 100644 (file)
index 0000000..fb404b8
--- /dev/null
@@ -0,0 +1,62 @@
+/*\r
+\r
+   Derby - Class org.apache.derby.iapi.sql.execute.CursorResultSet\r
+\r
+   Licensed to the Apache Software Foundation (ASF) under one or more\r
+   contributor license agreements.  See the NOTICE file distributed with\r
+   this work for additional information regarding copyright ownership.\r
+   The ASF licenses this file to you under the Apache License, Version 2.0\r
+   (the "License"); you may not use this file except in compliance with\r
+   the License.  You may obtain a copy of the License at\r
+\r
+      http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+   Unless required by applicable law or agreed to in writing, software\r
+   distributed under the License is distributed on an "AS IS" BASIS,\r
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+   See the License for the specific language governing permissions and\r
+   limitations under the License.\r
+\r
+ */\r
+\r
+package org.apache.derby.iapi.sql.execute;\r
+\r
+import org.apache.derby.iapi.sql.ResultSet;\r
+import org.apache.derby.iapi.types.RowLocation;\r
+import org.apache.derby.iapi.error.StandardException;\r
+\r
+/**\r
+ * The CursorResultSet interface is used to provide additional\r
+ * operations on result sets that can be used in cursors.\r
+ * <p>\r
+ * Since the ResulSet operations must also be supported by\r
+ * cursor result sets, we extend that interface here as well.\r
+ *\r
+ */\r
+public interface CursorResultSet extends ResultSet {\r
+\r
+       /**\r
+        * Returns the row location of the current base table row of the cursor.\r
+        * If this cursor's row is composed of multiple base tables' rows,\r
+        * i.e. due to a join, then a null is returned.\r
+        *\r
+        * @return the row location of the current cursor row.\r
+        * @exception StandardException thrown on failure to\r
+        *      get location from storage engine\r
+        */\r
+       RowLocation getRowLocation() throws StandardException;\r
+\r
+       /**\r
+        * Returns the current row of the result set.\r
+        * REMIND: eventually, this will only return the current row\r
+        * for result sets that need to return it; either some field\r
+        * in the activation or a parameter in the constructor will be\r
+        * used to signal that this needs to function. This will let us\r
+        * limit the number of live objects we are holding on to.\r
+        * <p>\r
+        * @return the last row returned by getNextRow. null if closed.\r
+        * @exception StandardException thrown on failure.\r
+        */\r
+       ExecRow getCurrentRow() throws StandardException;\r
+\r
+}\r