org.eclipse.persistence.config.ResultSetConcurrency Maven / Gradle / Ivy
Show all versions of org.eclipse.persistence.core Show documentation
/*
* Copyright (c) 1998, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// James Sutherland - initial impl
package org.eclipse.persistence.config;
/**
* JDBC ResultSet concurrency hint values.
*
* The class contains all the valid values for QueryHints.RESULT_SET_CONCURRENCY query hint.
* This can be used on ScrollableCursor queries to set the JDBC ResultSet concurrency.
*
* JPA Query Hint Usage:
*
* query.setHint(QueryHints.RESULT_SET_CONCURRENCY, ResultSetConcurrency.ForwardOnly);
*
or
*
@QueryHint(name=QueryHints.RESULT_SET_CONCURRENCY, value=ResultSetConcurrency.ForwardOnly)
*
*
Hint values are case-insensitive.
* "" could be used instead of default value ResultSetConcurrency.Updatable.
*
* @see QueryHints#RESULT_SET_CONCURRENCY
* @see org.eclipse.persistence.queries.ScrollableCursorPolicy#setResultSetConcurrency(int)
*
* @author James Sutherland
*/
public class ResultSetConcurrency {
/** The concurrency mode for a ResultSet object that may be updated. */
public static final String Updatable = "Updatable";
/** The concurrency mode for a ResultSet object that may NOT be updated. */
public static final String ReadOnly = "ReadOnly";
/**
* The default type is Updatable.
*/
public static final String DEFAULT = Updatable;
}