wamblee.org Git - utils/blob - support/general/src/main/java/org/wamblee/persistence/Persistent.java

   1 /*
   2  * Copyright 2005 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.wamblee.persistence;
  17
  18 import java.io.Serializable;
  19
  20 /**
  21  * Interface for persistent objects. This defines required functionality for all
  22  * objects that are persisted.
  23  *
  24  * Objects that implement this interface and which implement
  25  * {@link java.lang.Object#equals(java.lang.Object)} should exclude the primary
  26  * key and version from determining equality.
  27  */
  28 public interface Persistent {
  29     /**
  30      * Gets the primary key.
  31      *
  32      * @return Primary key.
  33      *
  34      * @see #setPrimaryKey(Serializable)
  35      */
  36     Serializable getPrimaryKey();
  37
  38     /**
  39      * Sets the primary key.
  40      *
  41      * @param aKey
  42      *            Primary key.
  43      *
  44      * @see #getPrimaryKey()
  45      */
  46     void setPrimaryKey(Serializable aKey);
  47
  48     /**
  49      * Gets the version.
  50      *
  51      * @return Version.
  52      *
  53      * @see #setPersistedVersion(int)
  54      */
  55     int getPersistedVersion();
  56
  57     /**
  58      * Sets the version.
  59      *
  60      * @param aVersion
  61      *            Version.
  62      *
  63      * @see #getPersistedVersion()
  64      */
  65     void setPersistedVersion(int aVersion);
  66 }