javax.persistence.criteria.Selection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpa-api Show documentation

Hibernate developmental JSR 317 (Java Persistence API 2.0) contracts. Used to allow incremental implementation of features on the way to full JPA 2.0 support.

The newest version!

// $Id: Selection.java 17038 2009-07-08 10:58:24Z epbernard $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.criteria;

import javax.persistence.TupleElement;
import java.util.List;

/**
 * The Selection interface defines an item that to be
 * returned in the query result.
 * @param  the type of the selection item
 */
public interface Selection extends TupleElement {

    /**
     * Return a selection item with the assigned alias.
     * @param name  alias
     * @return selection item
     */
    Selection alias(String name);

    /**
     * Whether the selection item is a compound selection
     * @return boolean
     */
    boolean isCompoundSelection();

    /**
     * Return selection items composing a compound selection
     * @return list of selection items
     * @throws IllegalStateException if selection is not a compound
     *           selection
     */
    List> getCompoundSelectionItems();

}