javax.persistence.criteria.ListJoin Maven / Gradle / Ivy
// $Id: ListJoin.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.criteria;
import java.util.List;
import javax.persistence.metamodel.ListAttribute;
/**
* The ListJoin interface is the type of the result of
* joining to a collection over an association or element
* collection that has been specified as a java.util.List.
*
* @param the source type of the join
* @param the element type of the target List
* @since Java Persistence 2.0
*/
public interface ListJoin
extends PluralJoin, E> {
/**
* Return the metamodel representation for the list attribute.
*
* @return metamodel type representing the List that is
* the target of the join
*/
ListAttribute getModel();
/**
* Create an expression that corresponds to the index of
* the object in the referenced association or element
* collection.
* This method must only be invoked upon an object that
* represents an association or element collection for
* which an order column has been defined.
*
* @return expression denoting the index
*/
Expression index();
}