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 */ 026package org.opends.server.admin.std.client; 027 028 029 030import org.opends.server.admin.ConfigurationClient; 031import org.opends.server.admin.ManagedObjectDefinition; 032import org.opends.server.admin.PropertyException; 033import org.opends.server.admin.std.server.AttributeSyntaxCfg; 034 035 036 037/** 038 * A client-side interface for reading and modifying Attribute Syntax 039 * settings. 040 * <p> 041 * Attribute Syntaxes define the type of data that may be stored in an 042 * attribute with that syntax. A syntax is generally associated with a 043 * set of matching rules that indicate how to perform matching 044 * operations against values of that syntax. 045 */ 046public interface AttributeSyntaxCfgClient extends ConfigurationClient { 047 048 /** 049 * Get the configuration definition associated with this Attribute Syntax. 050 * 051 * @return Returns the configuration definition associated with this Attribute Syntax. 052 */ 053 ManagedObjectDefinition<? extends AttributeSyntaxCfgClient, ? extends AttributeSyntaxCfg> definition(); 054 055 056 057 /** 058 * Gets the "enabled" property. 059 * <p> 060 * Indicates whether the Attribute Syntax is enabled. 061 * 062 * @return Returns the value of the "enabled" property. 063 */ 064 Boolean isEnabled(); 065 066 067 068 /** 069 * Sets the "enabled" property. 070 * <p> 071 * Indicates whether the Attribute Syntax is enabled. 072 * 073 * @param value The value of the "enabled" property. 074 * @throws PropertyException 075 * If the new value is invalid. 076 */ 077 void setEnabled(boolean value) throws PropertyException; 078 079 080 081 /** 082 * Gets the "java-class" property. 083 * <p> 084 * Specifies the fully-qualified name of the Java class that 085 * provides the Attribute Syntax implementation. 086 * 087 * @return Returns the value of the "java-class" property. 088 */ 089 String getJavaClass(); 090 091 092 093 /** 094 * Sets the "java-class" property. 095 * <p> 096 * Specifies the fully-qualified name of the Java class that 097 * provides the Attribute Syntax implementation. 098 * <p> 099 * This property is read-only and can only be modified during 100 * creation of a Attribute Syntax. 101 * 102 * @param value The value of the "java-class" property. 103 * @throws PropertyException 104 * If the new value is invalid. 105 * @throws PropertyException 106 * If this Attribute Syntax is not being initialized. 107 */ 108 void setJavaClass(String value) throws PropertyException, PropertyException; 109 110}