KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ldap > server > db > IndexAssertion


1 /*
2  * Copyright 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 package org.apache.ldap.server.db;
18
19
20 import javax.naming.NamingException JavaDoc;
21
22
23 /**
24  * Asserts whether or not a candidate should be returned in searching based on
25  * hard coded logic. This interface is not related to the filter AssertionNode.
26  * It is strictly used for purposes internal to the search engine.
27  *
28  * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
29  * @version $Rev: 169198 $
30  */
31 public interface IndexAssertion
32 {
33     /**
34      * Tests to see if a perspective candidate should be returned based on
35      * the evaluation of hard coded logic. If the entry has not been
36      * resusitated then the getAttributes member of the record will be null. As
37      * a side-effect an index assertion may populate the entry attribute after
38      * resusitating an entry from the master table.
39      *
40      * @param record an index record of the entry
41      * @return true if the entry should be returned, false otherwise
42      * @throws NamingException if their are failures while asserting the
43      * condition
44      */
45     boolean assertCandidate( IndexRecord record )
46         throws NamingException JavaDoc;
47 }
48
Popular Tags