javax.resource.cci.ResultSetInfo Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2008-2009, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.resource.cci;
import javax.resource.ResourceException;
/** The interface javax.resource.cci.ResultSetInfo provides
* information on the support provided for ResultSet by a connected
* EIS instance. A component calls the method
* Connection.getResultInfo to get the ResultSetInfo instance.
*
* A CCI implementation is not required to support
* javax.resource.cci.ResultSetInfo interface. The
* implementation of this interface is provided only if the CCI
* supports the ResultSet facility.
*
* @version 0.9
* @author Rahul Sharma
* @see javax.resource.cci.Connection
* @see java.sql.ResultSet
* @see javax.resource.cci.ConnectionMetaData
**/
public interface ResultSetInfo
{
/** Indicates whether or not a visible row update can be detected
* by calling the method ResultSet.rowUpdated.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if changes are detected by the result set
* type; false otherwise
* @see java.sql.ResultSet#rowUpdated
* @throws ResourceException Failed to get the information
**/
public boolean updatesAreDetected(int type) throws ResourceException;
/** Indicates whether or not a visible row insert can be detected
* by calling ResultSet.rowInserted.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if changes are detected by the result set
* type; false otherwise
* @see java.sql.ResultSet#rowInserted
* @throws ResourceException Failed to get the information
**/
public boolean insertsAreDetected(int type) throws ResourceException;
/** Indicates whether or not a visible row delete can be detected by
* calling ResultSet.rowDeleted. If deletesAreDetected
* returns false, then deleted rows are removed from the ResultSet.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if changes are detected by the result set
* type; false otherwise
* @see java.sql.ResultSet#rowDeleted
* @throws ResourceException Failed to get the information
**/
public boolean deletesAreDetected(int type) throws ResourceException;
/** Indicates whether or not a resource adapter supports a type
* of ResultSet.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if ResultSet type supported; false otherwise
* @throws ResourceException Failed to get the information
**/
public boolean supportsResultSetType(int type) throws ResourceException;
/** Indicates whether or not a resource adapter supports the
* concurrency type in combination with the given ResultSet type/
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @param concurrency ResultSet concurrency type defined in
* java.sql.ResultSet
* @return true if the specified combination supported; false otherwise
* @throws ResourceException Failed to get the information
**/
public boolean supportsResultTypeConcurrency(int type,
int concurrency)
throws ResourceException;
/** Indicates whether updates made by others are visible.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if updates by others are visible for the
* ResultSet type; false otherwise
* @throws ResourceException Failed to get the information
*/
public boolean othersUpdatesAreVisible(int type) throws ResourceException;
/**
* Indicates whether deletes made by others are visible.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if deletes by others are visible for the
* ResultSet type; false otherwise
* @throws ResourceException Failed to get the information
*/
public boolean othersDeletesAreVisible(int type) throws ResourceException;
/**
* Indicates whether inserts made by others are visible.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if inserts by others are visible for the
* ResultSet type; false otherwise
* @throws ResourceException Failed to get the information
*/
public boolean othersInsertsAreVisible(int type) throws ResourceException;
/** Indicates whether a ResultSet's own updates are visible.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if updates are visible for the ResultSet
* type; false otherwise
* @throws ResourceException Failed to get the information
**/
public boolean ownUpdatesAreVisible(int type) throws ResourceException;
/** Indicates whether a ResultSet's own inserts are visible.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if inserts are visible for the ResultSet
* type; false otherwise
* @throws ResourceException Failed to get the information
**/
public boolean ownInsertsAreVisible(int type) throws ResourceException;
/** Indicates whether a ResultSet's own deletes are visible.
*
* @param type type of the ResultSet i.e. ResultSet.TYPE_XXX
* @return true if inserts are visible for the ResultSet
* type; false otherwise
* @throws ResourceException Failed to get the information
**/
public boolean ownDeletesAreVisible(int type) throws ResourceException;
}