View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.core.api.criteria;
17  
18  import org.kuali.rice.core.api.util.jaxb.EnumStringAdapter;
19  
20  /**
21   * Defines possible directives for how a query is requested to produce count values in it's results.
22   * 
23   * @author Kuali Rice Team (rice.collab@kuali.org)
24   * 
25   */
26  public enum OrderDirection {
27  
28  	/**
29  	 * Indicates that rows will be returned in Ascending order.
30  	 */
31  	ASCENDING,
32  	
33  	/**
34  	 * Indicates that rows will be returned in descending order.
35  	 */
36  	DESCENDING;
37  
38  	/**
39  	 * Returns the value of the count flag.
40  	 * 
41  	 * @return the flag
42  	 */
43  	public String getDirection() {
44  		return toString();
45  	}
46  	
47  	static final class Adapter extends EnumStringAdapter<OrderDirection> {
48  		
49  		protected Class<OrderDirection> getEnumClass() {
50  			return OrderDirection.class;
51  		}
52  		
53  	}
54  	
55  }