001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.shared.ldap.schema.registries;
021    
022    
023    import javax.naming.NamingException;
024    
025    import org.apache.directory.shared.ldap.schema.LdapComparator;
026    
027    
028    /**
029     * Comparator registry component's service class.
030     *
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Rev: 896579 $
033     */
034    public interface ComparatorRegistry extends SchemaObjectRegistry<LdapComparator<?>>,
035        Iterable<LdapComparator<?>>
036    {
037        /**
038         * Registers a new LdapComparator with this registry.
039         *
040         * @param comparator the LdapComparator to register
041         * @throws NamingException if the LdapComparator is already registered or
042         * the registration operation is not supported
043         */
044        void register( LdapComparator<?> comparator ) throws NamingException;
045    
046    
047        /**
048         * Removes the LdapComparator registered with this registry, using its
049         * numeric OID.
050         * 
051         * @param numericOid the numeric identifier
052         * @throws NamingException if the numeric identifier is invalid
053         */
054        LdapComparator<?> unregister( String numericOid ) throws NamingException;
055        
056        
057        /**
058         * Unregisters all LdapComparators defined for a specific schema from
059         * this registry.
060         * 
061         * @param schemaName the name of the schema whose LdapComparators will be removed from
062         */
063        void unregisterSchemaElements( String schemaName ) throws NamingException;
064        
065        
066        /**
067         * Copy the ComparatorRegistry
068         */
069        ComparatorRegistry copy();
070    }