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.server.schema.registries;
021    
022    
023    import java.util.Iterator;
024    
025    import javax.naming.NamingException;
026    
027    import org.apache.directory.shared.ldap.schema.MatchingRule;
028    
029    
030    /**
031     * A registry used to track system matchingRules.
032     *
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev: 780471 $
035     */
036    public interface MatchingRuleRegistry extends SchemaObjectRegistry, Iterable<MatchingRule>
037    {
038        /**
039         * Registers a MatchingRule with this registry.
040         * 
041         * @param matchingRule the MatchingRule to register
042         * @throws NamingException if the matchingRule is already registered or the 
043         * registration operation is not supported
044         */
045        void register( MatchingRule matchingRule ) throws NamingException;
046    
047    
048        /**
049         * Looks up a MatchingRule by its unique Object Identifier or by name.
050         * 
051         * @param id the object identifier or the name identifier
052         * @return the MatchingRule for the id
053         * @throws NamingException if there is a backing store failure or the 
054         * MatchingRule does not exist.
055         */
056        MatchingRule lookup( String id ) throws NamingException;
057    
058    
059        /**
060         * Checks to see if a MatchingRule exists.  Backing store failures simply 
061         * return false.
062         * 
063         * @param oid the object identifier
064         * @return true if a MatchingRule definition exists for the oid, false 
065         * otherwise
066         */
067        boolean hasMatchingRule( String oid );
068    
069    
070        /**
071         * Gets an Iterator over the MatchingRules within this registry.
072         *
073         * @return an iterator over all MatchingRules in registry
074         */
075        Iterator<MatchingRule> iterator();
076    }