javax.persistence.criteria.PluralJoin 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: $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.criteria;

import javax.persistence.metamodel.PluralAttribute;

/**
 * The PluralJoin interface defines functionality
 * that is common to joins to all collection types.  It is
 * not intended to be used directly in query construction.
 *
 * @param  the source type
 * @param  the collection type
 * @param  the element type of the collection
 * @since Java Persistence 2.0
 */
public interface PluralJoin extends Join {

	/**
	 * Return the metamodel representation for the collection-valued
	 * attribute corresponding to the join.
	 *
	 * @return metamodel collection-valued attribute corresponding
	 *         to the target of the join
	 */
	PluralAttribute getModel();
}