1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 package org.kuali.rice.krad.criteria;
17
18 import org.kuali.rice.core.api.criteria.GenericQueryResults;
19 import org.kuali.rice.core.api.criteria.LookupCustomizer;
20 import org.kuali.rice.core.api.criteria.QueryByCriteria;
21
22 /**
23 * Defines basic methods that CriteriaLookup Dao's must provide
24 *
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public interface CriteriaLookupDao {
28
29 /**
30 * Looks up a type based on a query criteria.
31 *
32 * @param queryClass the class to lookup
33 * @param criteria the criteria to lookup against. cannot be null.
34 * @param <T> the type that is being looked up.
35 * @return the results. will never be null.
36 * @throws IllegalArgumentException if the criteria is null
37 */
38 <T> GenericQueryResults<T> lookup(final Class<T> queryClass, final QueryByCriteria criteria);
39
40 /**
41 * Looks up a type based on a query criteria.
42 *
43 * @param queryClass the class to lookup
44 * @param criteria the criteria to lookup against. cannot be null.
45 * @param <T> the type that is being looked up.
46 * @return the results. will never be null.
47 * @throws IllegalArgumentException if the criteria is null
48 */
49 <T> GenericQueryResults<T> lookup(final Class<T> queryClass, final QueryByCriteria criteria, LookupCustomizer<T> customizer);
50 }