trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/ComparatorRegistry.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.api.ldap.model.schema.registries;


import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.schema.LdapComparator;


/**
 * Comparator registry component's service class.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface ComparatorRegistry extends SchemaObjectRegistry<LdapComparator<?>>,
    Iterable<LdapComparator<?>>
{
    /**
     * Registers a new LdapComparator with this registry.
     *
     * @param comparator the LdapComparator to register
     * @throws LdapException if the LdapComparator is already registered or
     * the registration operation is not supported
     */
    void register( LdapComparator<?> comparator ) throws LdapException;


    /**
     * Removes the LdapComparator registered with this registry, using its
     * numeric OID.
     * 
     * @param numericOid the numeric identifier
     * @throws LdapException if the numeric identifier is invalid
     */
    LdapComparator<?> unregister( String numericOid ) throws LdapException;


    /**
     * Unregisters all LdapComparators defined for a specific schema from
     * this registry.
     * 
     * @param schemaName the name of the schema whose LdapComparators will be removed from
     */
    void unregisterSchemaElements( String schemaName ) throws LdapException;


    /**
     * Copy the ComparatorRegistry
     */
    ComparatorRegistry copy();
}