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 javax.persistence Show documentation

The Java Persistence API (JPA) : a standard interface-based Java model abstraction of persistence, developed by the JCP.

There is a newer version: 2.2.4

Show newest version

/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence.criteria;

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

/**
 * The Selection interface defines an item that is to be returned in a query result.
 * @param  the type of the selection item
 */
public interface Selection extends TupleElement
{
    /**
     * Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned.
     * Returns the same selection item.
     * @param name alias
     * @return selection item
     */
    Selection alias(String name);

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

    /**
     * Return the selection items composing a compound selection. Modifications to the list do not affect the
     * query.
     * @return list of selection items
     * @throws IllegalStateException if selection is not a compound selection
     */
    List> getCompoundSelectionItems();
}