001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.client;
017
018
019
020import java.util.Collection;
021import java.util.SortedSet;
022import org.forgerock.opendj.config.ManagedObjectDefinition;
023import org.forgerock.opendj.config.PropertyException;
024import org.forgerock.opendj.server.config.meta.CollationMatchingRuleCfgDefn.MatchingRuleType;
025import org.forgerock.opendj.server.config.server.CollationMatchingRuleCfg;
026
027
028
029/**
030 * A client-side interface for reading and modifying Collation
031 * Matching Rule settings.
032 * <p>
033 * Collation Matching Rules provide support for locale-specific
034 * filtering and indexing.
035 */
036public interface CollationMatchingRuleCfgClient extends MatchingRuleCfgClient {
037
038  /**
039   * Get the configuration definition associated with this Collation Matching Rule.
040   *
041   * @return Returns the configuration definition associated with this Collation Matching Rule.
042   */
043  ManagedObjectDefinition<? extends CollationMatchingRuleCfgClient, ? extends CollationMatchingRuleCfg> definition();
044
045
046
047  /**
048   * Gets the "collation" property.
049   * <p>
050   * the set of supported locales
051   * <p>
052   * Collation must be specified using the syntax: LOCALE:OID
053   *
054   * @return Returns the values of the "collation" property.
055   */
056  SortedSet<String> getCollation();
057
058
059
060  /**
061   * Sets the "collation" property.
062   * <p>
063   * the set of supported locales
064   * <p>
065   * Collation must be specified using the syntax: LOCALE:OID
066   *
067   * @param values The values of the "collation" property.
068   * @throws PropertyException
069   *           If one or more of the new values are invalid.
070   */
071  void setCollation(Collection<String> values) throws PropertyException;
072
073
074
075  /**
076   * Gets the "java-class" property.
077   * <p>
078   * Specifies the fully-qualified name of the Java class that
079   * provides the Collation Matching Rule implementation.
080   *
081   * @return Returns the value of the "java-class" property.
082   */
083  String getJavaClass();
084
085
086
087  /**
088   * Sets 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   * @param value The value of the "java-class" property.
094   * @throws PropertyException
095   *           If the new value is invalid.
096   */
097  void setJavaClass(String value) throws PropertyException;
098
099
100
101  /**
102   * Gets the "matching-rule-type" property.
103   * <p>
104   * the types of matching rules that should be supported for each
105   * locale
106   *
107   * @return Returns the values of the "matching-rule-type" property.
108   */
109  SortedSet<MatchingRuleType> getMatchingRuleType();
110
111
112
113  /**
114   * Sets the "matching-rule-type" property.
115   * <p>
116   * the types of matching rules that should be supported for each
117   * locale
118   *
119   * @param values The values of the "matching-rule-type" property.
120   * @throws PropertyException
121   *           If one or more of the new values are invalid.
122   */
123  void setMatchingRuleType(Collection<MatchingRuleType> values) throws PropertyException;
124
125}