1 package org.kuali.rice.core.api.criteria;
2
3 import org.kuali.rice.core.util.jaxb.EnumStringAdapter;
4
5 /**
6 * Defines possible directives for how a query is requested to produce count values in it's results.
7 *
8 * @author Kuali Rice Team (rice.collab@kuali.org)
9 *
10 */
11 public enum CountFlag {
12
13 /**
14 * Indicates that no row count should be returned with the query results.
15 */
16 NONE,
17
18 /**
19 * Indicates that the row count of the query should be returned with the query results.
20 */
21 INCLUDE,
22
23 /**
24 * Indicates that *only* the row count should be returned with the query results. The
25 * result should not include the actual rows returned from the query.
26 */
27 ONLY;
28
29 /**
30 * Returns the value of the count flag.
31 *
32 * @return the flag
33 */
34 public String getFlag() {
35 return toString();
36 }
37
38 static final class Adapter extends EnumStringAdapter<CountFlag> {
39
40 protected Class<CountFlag> getEnumClass() {
41 return CountFlag.class;
42 }
43
44 }
45
46 }