2 * Copyright 2005-2010 the original author or authors.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org.wamblee.persistence;
18 import java.io.Serializable;
21 * Interface for persistent objects. This defines required functionality for all
22 * objects that are persisted.
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.
28 public interface Persistent {
30 * Gets the primary key.
32 * @return Primary key.
34 * @see #setPrimaryKey(Serializable)
36 Serializable getPrimaryKey();
39 * Sets the primary key.
44 * @see #getPrimaryKey()
46 void setPrimaryKey(Serializable aKey);
53 * @see #setPersistedVersion(int)
55 int getPersistedVersion();
63 * @see #getPersistedVersion()
65 void setPersistedVersion(int aVersion);