View Javadoc

1   /*
2    * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3    * the spring framework, http://el4j.sf.net
4    * Copyright (C) 2005 by ELCA Informatique SA, Av. de la Harpe 22-24,
5    * 1000 Lausanne, Switzerland, http://www.elca.ch
6    *
7    * EL4J is published under the GNU Lesser General Public License (LGPL)
8    * Version 2.1. See http://www.gnu.org/licenses/
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13   * GNU Lesser General Public License for more details.
14   *
15   * For alternative licensing, please contact info@elca.ch
16   */
17  package ch.elca.el4j.services.persistence.generic.primarykey;
18  
19  import java.io.Serializable;
20  
21  /**
22   * An object PrimaryKeyGenerator is an object able to generate unique keys that
23   * can be used as primary keys for database storage.
24   *
25   * @svnLink $Revision: 3883 $;$Date: 2009-08-04 15:35:01 +0200 (Di, 04. Aug 2009) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/core/src/main/java/ch/elca/el4j/services/persistence/generic/primarykey/PrimaryKeyGenerator.java $
26   *
27   * @author Martin Zeltner (MZE)
28   */
29  public interface PrimaryKeyGenerator extends Serializable {
30  	/**
31  	 * Method to get a generated primary key.
32  	 *
33  	 * @return Returns generated primary key.
34  	 */
35  	public String getPrimaryKey();
36  }