/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Middleware LLC.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 */
package org.hibernate;

import java.sql.ResultSet;

Specifies the type of JDBC scrollable result set to use underneath a ScrollableResults. 
Author:
Gavin King/**
 * Specifies the type of JDBC scrollable result set to use underneath a {@link ScrollableResults}.
 *
 * @author Gavin King
 */
public enum ScrollMode {
	
Requests a scrollable result that is only scrollable forwards.
See Also:
TYPE_FORWARD_ONLY.TYPE_FORWARD_ONLY/**
	 * Requests a scrollable result that is only scrollable forwards.
	 *
	 * @see java.sql.ResultSet#TYPE_FORWARD_ONLY
	 */
	FORWARD_ONLY( ResultSet.TYPE_FORWARD_ONLY ),

	
Requests a scrollable result which is sensitive to changes in the underlying data.
See Also:
TYPE_SCROLL_SENSITIVE.TYPE_SCROLL_SENSITIVE/**
	 * Requests a scrollable result which is sensitive to changes in the underlying data.
	 *
	 * @see java.sql.ResultSet#TYPE_SCROLL_SENSITIVE
	 */
	SCROLL_SENSITIVE( ResultSet.TYPE_SCROLL_SENSITIVE ),

	
Requests a scrollable result which is insensitive to changes in the underlying data.
Note that since the Hibernate session acts as a cache, you
might need to explicitly evict objects, if you need to see
changes made by other transactions.
See Also:
TYPE_SCROLL_INSENSITIVE.TYPE_SCROLL_INSENSITIVE/**
	 * Requests a scrollable result which is insensitive to changes in the underlying data.
	 *
	 * Note that since the Hibernate session acts as a cache, you
	 * might need to explicitly evict objects, if you need to see
	 * changes made by other transactions.
	 *
	 * @see java.sql.ResultSet#TYPE_SCROLL_INSENSITIVE
	 */
	SCROLL_INSENSITIVE( ResultSet.TYPE_SCROLL_INSENSITIVE );

	private final int resultSetType;

	private ScrollMode(int level) {
		this.resultSetType = level;
	}

	
Get the corresponding JDBC scroll type code constant value.
Returns:
the JDBC result set type code/**
	 * Get the corresponding JDBC scroll type code constant value.
	 *
	 * @return the JDBC result set type code
	 */
	public int toResultSetType() {
		return resultSetType;
	}

	
Determine if this mode is "less than" the provided mode. 
Params:
other – The provided mode
Returns:
true if this mode is less than the other./**
	 * Determine if {@code this} mode is "less than" the provided mode.
	 *
	 * @param other The provided mode
	 *
	 * @return {@code true} if this mode is less than the other.
	 */
	public boolean lessThan(ScrollMode other) {
		return this.resultSetType < other.resultSetType;
	}

}