KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > resource > cci > ResultSetInfo


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 package javax.resource.cci;
25
26
27 import javax.resource.ResourceException JavaDoc;
28
29 /** The interface <code>javax.resource.cci.ResultSetInfo</code> provides
30  * information on the support provided for ResultSet by a connected
31  * EIS instance. A component calls the method
32  * <code>Connection.getResultInfo</code> to get the ResultSetInfo instance.
33  *
34  * <p>A CCI implementation is not required to support
35  * <code>javax.resource.cci.ResultSetInfo</code> interface. The
36  * implementation of this interface is provided only if the CCI
37  * supports the ResultSet facility.
38  *
39  * @version 0.9
40  * @author Rahul Sharma
41  * @see javax.resource.cci.Connection
42  * @see java.sql.ResultSet
43  * @see javax.resource.cci.ConnectionMetaData
44 **/
45
46 public interface ResultSetInfo {
47   
48   /** Indicates whether or not a visible row update can be detected
49    * by calling the method <code>ResultSet.rowUpdated</code>.
50    *
51    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
52    * @return true if changes are detected by the result set
53    * type; false otherwise
54    * @see java.sql.ResultSet#rowUpdated
55    * @throws ResourceException Failed to get the information
56   **/
57   public
58   boolean updatesAreDetected(int type) throws ResourceException JavaDoc;
59
60   /** Indicates whether or not a visible row insert can be detected
61    * by calling ResultSet.rowInserted.
62    *
63    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
64    * @return true if changes are detected by the result set
65    * type; false otherwise
66    * @see java.sql.ResultSet#rowInserted
67    * @throws ResourceException Failed to get the information
68   **/
69   public
70   boolean insertsAreDetected(int type) throws ResourceException JavaDoc;
71     
72   /* Indicates whether or not a visible row delete can be detected by
73    * calling ResultSet.rowDeleted. If deletesAreDetected
74    * returns false, then deleted rows are removed from the ResultSet.
75    *
76    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
77    * @return true if changes are detected by the result set
78    * type; false otherwise
79    * @see java.sql.ResultSet#rowDeleted
80    * @throws ResourceException Failed to get the information
81   **/
82   public
83   boolean deletesAreDetected(int type) throws ResourceException JavaDoc;
84   
85   /** Indicates whether or not a resource adapter supports a type
86    * of ResultSet.
87    *
88    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
89    * @return true if ResultSet type supported; false otherwise
90    * @throws ResourceException Failed to get the information
91   **/
92   public
93   boolean supportsResultSetType(int type) throws ResourceException JavaDoc;
94
95   /** Indicates whether or not a resource adapter supports the
96    * concurrency type in combination with the given ResultSet type/
97    *
98    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
99    * @param concurrency ResultSet concurrency type defined in
100    * java.sql.ResultSet
101    * @return true if the specified combination supported; false otherwise
102    * @throws ResourceException Failed to get the information
103   **/
104   public
105   boolean supportsResultTypeConcurrency(int type,
106                     int concurrency)
107                                              throws ResourceException JavaDoc;
108
109
110   /** Indicates whether updates made by others are visible.
111    *
112    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
113    * @return true if updates by others are visible for the
114    * ResultSet type; false otherwise
115    * @throws ResourceException Failed to get the information
116    */
117   public
118   boolean othersUpdatesAreVisible(int type) throws ResourceException JavaDoc;
119
120   /**
121    * Indicates whether deletes made by others are visible.
122    *
123    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
124    * @return true if deletes by others are visible for the
125    * ResultSet type; false otherwise
126    * @throws ResourceException Failed to get the information
127    */
128   public
129   boolean othersDeletesAreVisible(int type) throws ResourceException JavaDoc;
130     
131   /**
132    * Indicates whether inserts made by others are visible.
133    *
134    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
135    * @return true if inserts by others are visible for the
136    * ResultSet type; false otherwise
137    * @throws ResourceException Failed to get the information
138    */
139   public
140   boolean othersInsertsAreVisible(int type) throws ResourceException JavaDoc;
141
142
143   /* Indicates whether a ResultSet's own updates are visible.
144    *
145    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
146    * @return true if updates are visible for the ResultSet
147    * type; false otherwise
148    * @throws ResourceException Failed to get the information
149   **/
150   public
151   boolean ownUpdatesAreVisible(int type) throws ResourceException JavaDoc;
152
153   /* Indicates whether a ResultSet's own inserts are visible.
154    *
155    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
156    * @return true if inserts are visible for the ResultSet
157    * type; false otherwise
158    * @throws ResourceException Failed to get the information
159   **/
160   public
161   boolean ownInsertsAreVisible(int type) throws ResourceException JavaDoc;
162
163   /* Indicates whether a ResultSet's own deletes are visible.
164    *
165    * @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
166    * @return true if inserts are visible for the ResultSet
167    * type; false otherwise
168    * @throws ResourceException Failed to get the information
169   **/
170   public
171   boolean ownDeletesAreVisible(int type) throws ResourceException JavaDoc;
172
173 }
174
Popular Tags