1. /*
  2. * Copyright 2002-2004 the original author or authors.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. package org.springframework.jdbc.support.incrementer;
  17. import org.springframework.dao.DataAccessException;
  18. /**
  19. * Interface that defines contract of incrementing any data store field's
  20. * maximum value. Works much like a sequence number generator.
  21. *
  22. * <p>Typical implementations can use RDBMS SQL, native RDBMS sequences,
  23. * and/or Stored Procedures to do the job.
  24. *
  25. * @author Dmitriy Kopylenko
  26. * @author Isabelle Muszynski
  27. * @author Jean-Pierre Pawlak
  28. * @version $Id: DataFieldMaxValueIncrementer.java,v 1.3 2004/03/18 02:46:11 trisberg Exp $
  29. */
  30. public interface DataFieldMaxValueIncrementer {
  31. /**
  32. * Increments data store field's max value as int.
  33. * @return int next data store value such as <b>max + 1</b>
  34. * @throws org.springframework.dao.DataAccessException
  35. */
  36. int nextIntValue() throws DataAccessException;
  37. /**
  38. * Increments data store field's max value as long.
  39. * @return int next data store value such as <b>max + 1</b>
  40. * @throws org.springframework.dao.DataAccessException
  41. */
  42. long nextLongValue() throws DataAccessException;
  43. /**
  44. * Increments data store field's max value as String.
  45. * @return next data store value such as <b>max + 1</b>
  46. * @throws org.springframework.dao.DataAccessException
  47. */
  48. String nextStringValue() throws DataAccessException;
  49. }