View Javadoc
1   /**
2    * Copyright 2005-2015 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  import org.kuali.rice.krad.util.LegacyDataFramework;
22  
23  /**
24   * Defines basic methods that CriteriaLookup Dao's must provide
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   * @deprecated use new KRAD Data framework {@link org.kuali.rice.krad.data.DataObjectService}
28   */
29  @Deprecated
30  @LegacyDataFramework
31  public interface CriteriaLookupDao {
32  
33      /**
34       * Looks up a type based on a query criteria.
35       *
36       * @param queryClass the class to lookup
37       * @param criteria the criteria to lookup against. cannot be null.
38       * @param <T> the type that is being looked up.
39       * @return the results. will never be null.
40       * @throws IllegalArgumentException if the criteria is null
41       */
42      <T> GenericQueryResults<T> lookup(final Class<T> queryClass, final QueryByCriteria criteria);
43  
44      /**
45       * Looks up a type based on a query criteria.
46       *
47       * @param queryClass the class to lookup
48       * @param criteria the criteria to lookup against. cannot be null.
49       * @param <T> the type that is being looked up.
50       * @return the results. will never be null.
51       * @throws IllegalArgumentException if the criteria is null
52       */
53      <T> GenericQueryResults<T> lookup(final Class<T> queryClass, final QueryByCriteria criteria, LookupCustomizer<T> customizer);
54  }