org.hibernate.envers.boot.model.Keyable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-envers Show documentation

Hibernate's entity version (audit/history) support

There is a newer version: 7.0.0.Beta2

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.envers.boot.model;

/**
 * Contract that defines an attribute that can participate in a key.
 *
 * @author Chris Cranford
 */
public interface Keyable {
	/**
	 * Get whether the attribute is already participatig in a key.
	 * @return true if the attribute is in the key; false otherwise
	 */
	boolean isKey();

	/**
	 * Set whether this attribute should or shouldn't participate as a key attribute.
	 * @param key specifies if the attribute is part of the key
	 */
	void setKey(boolean key);
}