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.core.partition.impl.btree;
021    
022    
023    import org.apache.directory.server.xdbm.IndexEntry;
024    
025    import javax.naming.NamingException;
026    
027    
028    /**
029     * Asserts whether or not a candidate should be returned in searching based on
030     * hard coded logic.  This interface is not related to the filter AssertionNode.
031     * It is strictly used for purposes internal to the search engine.
032     * 
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev: 917312 $
035     */
036    public interface IndexAssertion<K, E, ID>
037    {
038        /**
039         * Tests to see if a perspective candidate should be returned based on 
040         * the evaluation of hard coded logic.  If the entry has not been 
041         * resusitated then the getObject member of the record will be null.  As
042         * a side-effect an index assertion may populate the entry attribute after
043         * resusitating an entry from the master table.
044         * 
045         * @param entry an index record of the entry
046         * @return true if the entry should be returned, false otherwise
047         * @throws NamingException if their are failures while asserting the 
048         * condition
049         */
050        boolean assertCandidate( IndexEntry<K, E, ID> entry ) throws Exception;
051    }