1 /**
2 * Copyright 2005-2012 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 CountFlag {
27
28 /**
29 * Indicates that no row count should be returned with the query results.
30 */
31 NONE,
32
33 /**
34 * Indicates that the row count of the query should be returned with the query results.
35 */
36 INCLUDE,
37
38 /**
39 * Indicates that *only* the row count should be returned with the query results. The
40 * result should not include the actual rows returned from the query.
41 */
42 ONLY;
43
44 /**
45 * Returns the value of the count flag.
46 *
47 * @return the flag
48 */
49 public String getFlag() {
50 return toString();
51 }
52
53 static final class Adapter extends EnumStringAdapter<CountFlag> {
54
55 protected Class<CountFlag> getEnumClass() {
56 return CountFlag.class;
57 }
58
59 }
60
61 }