001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016
017package org.forgerock.json.resource;
018
019/**
020 * An enum of count policy types.
021 *
022 * @see QueryRequest#setTotalPagedResultsPolicy(CountPolicy)
023 * @see QueryResponse#getTotalPagedResultsPolicy()
024 */
025public enum CountPolicy {
026    /**
027     * There should be no count returned. No overhead should be incurred.
028     */
029    NONE,
030
031    /**
032     * Estimated count may be used. If no estimation is available it is up to the implementor whether to return
033     * an {@link #EXACT} count or {@link #NONE}. It should be known to the client which was used as in
034     * {@link QueryResponse#getTotalPagedResultsPolicy()}
035     */
036    ESTIMATE,
037
038    /**
039     * Exact count is required.
040     */
041    EXACT
042}