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.server;
027
028
029
030import java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032import org.opends.server.admin.std.meta.CollationMatchingRuleCfgDefn.MatchingRuleType;
033
034
035
036/**
037 * A server-side interface for querying Collation Matching Rule
038 * settings.
039 * <p>
040 * Collation Matching Rules provide support for locale-specific
041 * filtering and indexing.
042 */
043public interface CollationMatchingRuleCfg extends MatchingRuleCfg {
044
045  /**
046   * Gets the configuration class associated with this Collation Matching Rule.
047   *
048   * @return Returns the configuration class associated with this Collation Matching Rule.
049   */
050  Class<? extends CollationMatchingRuleCfg> configurationClass();
051
052
053
054  /**
055   * Register to be notified when this Collation Matching Rule is changed.
056   *
057   * @param listener
058   *          The Collation Matching Rule configuration change listener.
059   */
060  void addCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener);
061
062
063
064  /**
065   * Deregister an existing Collation Matching Rule configuration change listener.
066   *
067   * @param listener
068   *          The Collation Matching Rule configuration change listener.
069   */
070  void removeCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener);
071
072
073
074  /**
075   * Gets the "collation" property.
076   * <p>
077   * the set of supported locales
078   * <p>
079   * Collation must be specified using the syntax: LOCALE:OID
080   *
081   * @return Returns an unmodifiable set containing the values of the "collation" property.
082   */
083  SortedSet<String> getCollation();
084
085
086
087  /**
088   * Gets the "java-class" property.
089   * <p>
090   * Specifies the fully-qualified name of the Java class that
091   * provides the Collation Matching Rule implementation.
092   *
093   * @return Returns the value of the "java-class" property.
094   */
095  String getJavaClass();
096
097
098
099  /**
100   * Gets the "matching-rule-type" property.
101   * <p>
102   * the types of matching rules that should be supported for each
103   * locale
104   *
105   * @return Returns an unmodifiable set containing the values of the "matching-rule-type" property.
106   */
107  SortedSet<MatchingRuleType> getMatchingRuleType();
108
109}