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