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 2016 ForgeRock AS.
015 */
016
017package org.forgerock.api.enums;
018
019import org.forgerock.api.models.Schema;
020
021/**
022 * Enum that represents the {@link Schema} read policies.
023 */
024public enum ReadPolicy {
025    /**
026     * Property is readable via client APIs and <em>visible</em> in the user-interface.
027     */
028    USER,
029    /**
030     * Property is hidden from user-interface, but readable via client APIs. This is the default value if
031     * {@code ReadPolicy} is not specified.
032     */
033    CLIENT,
034    /**
035     * Property is available internally, but not exposed to client APIs. Applications must actively filter this
036     * value from client API responses.
037     */
038    SERVER
039}