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 */ 020package org.apache.directory.api.ldap.model.schema.registries; 021 022 023import org.apache.directory.api.ldap.model.exception.LdapException; 024import org.apache.directory.api.ldap.model.schema.LdapComparator; 025 026 027/** 028 * Comparator registry component's service class. 029 * 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 */ 032public interface ComparatorRegistry extends SchemaObjectRegistry<LdapComparator<?>>, 033 Iterable<LdapComparator<?>> 034{ 035 /** 036 * Registers a new LdapComparator with this registry. 037 * 038 * @param comparator the LdapComparator to register 039 * @throws LdapException if the LdapComparator is already registered or 040 * the registration operation is not supported 041 */ 042 @Override 043 void register( LdapComparator<?> comparator ) throws LdapException; 044 045 046 /** 047 * Removes the LdapComparator registered with this registry, using its 048 * numeric OID. 049 * 050 * @param numericOid the numeric identifier 051 * @throws LdapException if the numeric identifier is invalid 052 */ 053 @Override 054 LdapComparator<?> unregister( String numericOid ) throws LdapException; 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 @Override 064 void unregisterSchemaElements( String schemaName ) throws LdapException; 065 066 067 /** 068 * Copy the ComparatorRegistry 069 */ 070 @Override 071 ComparatorRegistry copy(); 072}