1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2015 ForgeRock AS.
15 */
16
17 package org.forgerock.json.resource;
18
19 /**
20 * An enum of count policy types.
21 *
22 * @see QueryRequest#setTotalPagedResultsPolicy(CountPolicy)
23 * @see QueryResponse#getTotalPagedResultsPolicy()
24 */
25 public enum CountPolicy {
26 /**
27 * There should be no count returned. No overhead should be incurred.
28 */
29 NONE,
30
31 /**
32 * Estimated count may be used. If no estimation is available it is up to the implementor whether to return
33 * an {@link #EXACT} count or {@link #NONE}. It should be known to the client which was used as in
34 * {@link QueryResponse#getTotalPagedResultsPolicy()}
35 */
36 ESTIMATE,
37
38 /**
39 * Exact count is required.
40 */
41 EXACT
42 }