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.Syntax;
028    
029    
030    /**
031     * Manages the lookup and registration of Syntaxes within the system by OID.
032     *
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev: 780471 $
035     */
036    public interface SyntaxRegistry extends SchemaObjectRegistry, Iterable<Syntax>
037    {
038        /**
039         * Looks up a Syntax by its unique Object Identifier or by name.
040         * 
041         * @param id the object identifier or name
042         * @return the Syntax for the id
043         * @throws NamingException if there is a backing store failure or the Syntax
044         * does not exist.
045         */
046        Syntax lookup( String id ) throws NamingException;
047    
048    
049        /**
050         * Registers a Syntax with this registry.  
051         * 
052         * @param syntax the Syntax to register
053         * @throws NamingException if the syntax is already registered or the 
054         * registration operation is not supported
055         */
056        void register( Syntax syntax ) throws NamingException;
057    
058    
059        /**
060         * Checks to see if a Syntax exists.  Backing store failures simply return
061         * false.
062         * 
063         * @param id the object identifier or name
064         * @return true if a Syntax definition exists for the id, false otherwise
065         */
066        boolean hasSyntax( String id );
067    
068    
069        /**
070         * Lists all the Syntaxes within this registry.
071         *
072         * @return an Iterator over all the Syntaxes within this registry
073         */
074        Iterator<Syntax> iterator();
075    }