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 java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.meta.CollationMatchingRuleCfgDefn.MatchingRuleType;
035import org.opends.server.admin.std.server.CollationMatchingRuleCfg;
036
037
038
039/**
040 * A client-side interface for reading and modifying Collation
041 * Matching Rule settings.
042 * <p>
043 * Collation Matching Rules provide support for locale-specific
044 * filtering and indexing.
045 */
046public interface CollationMatchingRuleCfgClient extends MatchingRuleCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Collation Matching Rule.
050   *
051   * @return Returns the configuration definition associated with this Collation Matching Rule.
052   */
053  ManagedObjectDefinition<? extends CollationMatchingRuleCfgClient, ? extends CollationMatchingRuleCfg> definition();
054
055
056
057  /**
058   * Gets the "collation" property.
059   * <p>
060   * the set of supported locales
061   * <p>
062   * Collation must be specified using the syntax: LOCALE:OID
063   *
064   * @return Returns the values of the "collation" property.
065   */
066  SortedSet<String> getCollation();
067
068
069
070  /**
071   * Sets the "collation" property.
072   * <p>
073   * the set of supported locales
074   * <p>
075   * Collation must be specified using the syntax: LOCALE:OID
076   *
077   * @param values The values of the "collation" property.
078   * @throws PropertyException
079   *           If one or more of the new values are invalid.
080   */
081  void setCollation(Collection<String> values) throws PropertyException;
082
083
084
085  /**
086   * Gets the "java-class" property.
087   * <p>
088   * Specifies the fully-qualified name of the Java class that
089   * provides the Collation Matching Rule implementation.
090   *
091   * @return Returns the value of the "java-class" property.
092   */
093  String getJavaClass();
094
095
096
097  /**
098   * Sets the "java-class" property.
099   * <p>
100   * Specifies the fully-qualified name of the Java class that
101   * provides the Collation Matching Rule implementation.
102   *
103   * @param value The value of the "java-class" property.
104   * @throws PropertyException
105   *           If the new value is invalid.
106   */
107  void setJavaClass(String value) throws PropertyException;
108
109
110
111  /**
112   * Gets the "matching-rule-type" property.
113   * <p>
114   * the types of matching rules that should be supported for each
115   * locale
116   *
117   * @return Returns the values of the "matching-rule-type" property.
118   */
119  SortedSet<MatchingRuleType> getMatchingRuleType();
120
121
122
123  /**
124   * Sets the "matching-rule-type" property.
125   * <p>
126   * the types of matching rules that should be supported for each
127   * locale
128   *
129   * @param values The values of the "matching-rule-type" property.
130   * @throws PropertyException
131   *           If one or more of the new values are invalid.
132   */
133  void setMatchingRuleType(Collection<MatchingRuleType> values) throws PropertyException;
134
135}