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