javax.persistence.metamodel.IdentifiableType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation
Hibernate definition of the Java Persistence 2.0 (JSR 317) API.
There is a newer version: 1.0.1.Final
Show newest version
// $Id: IdentifiableType.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.metamodel;

import java.util.Set;

/**
 * Instances of the type IdentifiableType represent entity or
 * mapped superclass types.
 *
 * @param  The represented entity or mapped superclass type.
 * @since Java Persistence 2.0
 */
public interface IdentifiableType extends ManagedType {
	/**
	 * Return the attribute that corresponds to the id attribute of
	 * the entity or mapped superclass.
	 *
	 * @param type the type of the represented id attribute
	 *
	 * @return id attribute
	 *
	 * @throws IllegalArgumentException if id attribute of the given
	 * type is not present in the identifiable type or if
	 * the identifiable type has an id class
	 */
	 SingularAttribute getId(Class type);

	/**
	 * Return the attribute that corresponds to the id attribute
	 * declared by the entity or mapped superclass.
	 *
	 * @param type the type of the represented declared
	 * id attribute
	 *
	 * @return declared id attribute
	 *
	 * @throws IllegalArgumentException if id attribute of the given
	 * type is not declared in the identifiable type or if
	 * the identifiable type has an id class
	 */
	 SingularAttribute getDeclaredId(Class type);

	/**
	 * Return the attribute that corresponds to the version
	 * attribute of the entity or mapped superclass.
	 *
	 * @param type the type of the represented version attribute
	 *
	 * @return version attribute
	 *
	 * @throws IllegalArgumentException if version attribute of the
	 * given type is not present in the identifiable type
	 */
	 SingularAttribute getVersion(Class type);

	/**
	 * Return the attribute that corresponds to the version
	 * attribute declared by the entity or mapped superclass.
	 *
	 * @param type the type of the represented declared version
	 * attribute
	 *
	 * @return declared version attribute
	 *
	 * @throws IllegalArgumentException if version attribute of the
	 * type is not declared in the identifiable type
	 */
	 SingularAttribute getDeclaredVersion(Class type);

	/**
	 * Return the identifiable type that corresponds to the most
	 * specific mapped superclass or entity extended by the entity
	 * or mapped superclass.
	 *
	 * @return supertype of identifiable type or null if no
	 *         such supertype
	 */
	IdentifiableType getSupertype();

	/**
	 * Whether the identifiable type has a single id attribute.
	 * Returns true for a simple id or embedded id; returns false
	 * for an idclass.
	 *
	 * @return boolean indicating whether the identifiable
	 *         type has a single id attribute
	 */
	boolean hasSingleIdAttribute();

	/**
	 * Whether the identifiable type has a version attribute.
	 *
	 * @return boolean indicating whether the identifiable
	 *         type has a version attribute
	 */
	boolean hasVersionAttribute();

	/**
	 * Return the attributes corresponding to the id class of the
	 * identifiable type.
	 *
	 * @return id attributes
	 *
	 * @throws IllegalArgumentException if the identifiable type
	 * does not have an id class
	 */
	Set> getIdClassAttributes();

	/**
	 * Return the type that represents the type of the id.
	 *
	 * @return type of id
	 */
	Type getIdType();
}