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 2016 ForgeRock AS.
15 */
16
17 package org.forgerock.api.enums;
18
19 import org.forgerock.api.models.Schema;
20
21 /**
22 * Enum that represents the {@link Schema} read policies.
23 */
24 public enum ReadPolicy {
25 /**
26 * Property is readable via client APIs and <em>visible</em> in the user-interface.
27 */
28 USER,
29 /**
30 * Property is hidden from user-interface, but readable via client APIs. This is the default value if
31 * {@code ReadPolicy} is not specified.
32 */
33 CLIENT,
34 /**
35 * Property is available internally, but not exposed to client APIs. Applications must actively filter this
36 * value from client API responses.
37 */
38 SERVER
39 }