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

Go to download

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

Clean-room definition of JPA APIs intended for use in developing Hibernate JPA implementation. See README.md for details

There is a newer version: 1.0.2.Final

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;

/**
 * An object that defines an ordering over the query results.
 *
 * @since Java Persistence 2.0
 */
public interface Order {
	/**
	 * Switch the ordering.
	 *
	 * @return a new Order instance with the reversed ordering
	 */
	Order reverse();

	/**
	 * Whether ascending ordering is in effect.
	 *
	 * @return boolean indicating whether ordering is ascending
	 */
	boolean isAscending();

	/**
	 * Return the expression that is used for ordering.
	 *
	 * @return expression used for ordering
	 */
	Expression getExpression();
}