View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.model.schema.registries;
21  
22  
23  import org.apache.directory.api.ldap.model.exception.LdapException;
24  import org.apache.directory.api.ldap.model.schema.LdapComparator;
25  
26  
27  /**
28   * Comparator registry component's service class.
29   *
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public interface ComparatorRegistry extends SchemaObjectRegistry<LdapComparator<?>>,
33      Iterable<LdapComparator<?>>
34  {
35      /**
36       * Registers a new LdapComparator with this registry.
37       *
38       * @param comparator the LdapComparator to register
39       * @throws LdapException if the LdapComparator is already registered or
40       * the registration operation is not supported
41       */
42      @Override
43      void register( LdapComparator<?> comparator ) throws LdapException;
44  
45  
46      /**
47       * Removes the LdapComparator registered with this registry, using its
48       * numeric OID.
49       * 
50       * @param numericOid the numeric identifier
51       * @throws LdapException if the numeric identifier is invalid
52       */
53      @Override
54      LdapComparator<?> unregister( String numericOid ) throws LdapException;
55  
56  
57      /**
58       * Unregisters all LdapComparators defined for a specific schema from
59       * this registry.
60       * 
61       * @param schemaName the name of the schema whose LdapComparators will be removed from
62       */
63      @Override
64      void unregisterSchemaElements( String schemaName ) throws LdapException;
65  
66  
67      /**
68       * Copy the ComparatorRegistry
69       */
70      @Override
71      ComparatorRegistry copy();
72  }