001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026
027package org.opends.server.admin;
028
029
030
031/**
032 * This enumeration contains various options that can be associated
033 * with property definitions.
034 */
035public enum PropertyOption {
036  /**
037   * Use this option to identify properties which should be considered
038   * as advanced and should not be exposed by default in client
039   * applications.
040   */
041  ADVANCED,
042
043  /**
044   * Use this option to identify properties which must not be directly
045   * exposed in client applications.
046   */
047  HIDDEN,
048
049  /**
050   * Use this option to identify properties which must have a value.
051   */
052  MANDATORY,
053
054  /**
055   * Use this option to identify properties which are multi-valued.
056   */
057  MULTI_VALUED,
058
059  /**
060   * Use this option to identify properties which can be initialized
061   * once only and are read-only thereafter.
062   */
063  READ_ONLY,
064
065  /**
066   * Use this option to identify properties which are for monitoring
067   * purposes only and are generated automatically by the server..
068   */
069  MONITORING;
070}