Package: Order

Order

Coverage

1: /**
2: * Copyright (C) 2011 Czech Technical University in Prague
3: *
4: * This program is free software: you can redistribute it and/or modify it under
5: * the terms of the GNU General Public License as published by the Free Software
6: * Foundation, either version 3 of the License, or (at your option) any
7: * later version.
8: *
9: * This program is distributed in the hope that it will be useful, but WITHOUT
10: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12: * details. You should have received a copy of the GNU General Public License
13: * along with this program. If not, see <http://www.gnu.org/licenses/>.
14: */
15:
16: package cz.cvut.kbss.jopa.model.query.criteria;
17:
18: /**
19: * An object that defines an ordering over the query results.
20: */
21: public interface Order {
22:         /**
23:          * Switch the ordering.
24:          *
25:          * @return a new Order instance with the reversed ordering
26:          */
27:         Order reverse();
28:
29:         /**
30:          * Whether ascending ordering is in effect.
31:          *
32:          * @return boolean indicating whether ordering is ascending
33:          */
34:         boolean isAscending();
35:
36:         /**
37:          * Return the expression that is used for ordering.
38:          *
39:          * @return expression used for ordering
40:          */
41:         Expression<?> getExpression();
42: }