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.filter; 21 22 23 import javax.naming.NamingException; 24 25 import org.apache.directory.api.ldap.model.entry.Entry; 26 27 28 /** 29 * A candidacy predicate which tests if an entry satisfies some condition before 30 * being returned by a search. 31 * 32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 33 */ 34 public interface Assertion extends Cloneable 35 { 36 /** 37 * Checks to see if a candidate is valid by asserting an arbitrary predicate 38 * against the candidate. Where available entry will be provided 39 * however there is no guarantee. The entry's attributes are only provided 40 * if they were previously accessed. All assertions should handle cases 41 * where the entry argument is null. 42 * 43 * @param entry the entry if available 44 * @return true if the candidate satisfies the predicate, false otherwise 45 * @throws NamingException if an error occurs while asserting the predicate 46 */ 47 boolean assertCandidate( Entry entry ) throws NamingException; 48 }