001/*
002 * Copyright 2002-2007 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.jdbc.support.incrementer;
018
019import org.springframework.dao.DataAccessException;
020
021/**
022 * Interface that defines contract of incrementing any data store field's
023 * maximum value. Works much like a sequence number generator.
024 *
025 * <p>Typical implementations may use standard SQL, native RDBMS sequences
026 * or Stored Procedures to do the job.
027 *
028 * @author Dmitriy Kopylenko
029 * @author Jean-Pierre Pawlak
030 * @author Juergen Hoeller
031 */
032public interface DataFieldMaxValueIncrementer {
033
034        /**
035         * Increment the data store field's max value as int.
036         * @return int next data store value such as <b>max + 1</b>
037         * @throws org.springframework.dao.DataAccessException in case of errors
038         */
039        int nextIntValue() throws DataAccessException;
040
041        /**
042         * Increment the data store field's max value as long.
043         * @return int next data store value such as <b>max + 1</b>
044         * @throws org.springframework.dao.DataAccessException in case of errors
045         */
046        long nextLongValue() throws DataAccessException;
047
048        /**
049         * Increment the data store field's max value as String.
050         * @return next data store value such as <b>max + 1</b>
051         * @throws org.springframework.dao.DataAccessException in case of errors
052         */
053        String nextStringValue() throws DataAccessException;
054
055}