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.dao;
17
18 import org.kuali.rice.krad.util.LegacyDataFramework;
19
20 import java.util.Collection;
21 import java.util.Map;
22
23 /**
24 * Defines basic methods that Lookup Dao's must provide
25 * @deprecated use new KRAD Data framework {@link org.kuali.rice.krad.data.DataObjectService}
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 @Deprecated
29 @LegacyDataFramework
30 public interface LookupDao {
31 /**
32 * Retrieves a collection of objects for the businessObjectClass based on the other information passed into the
33 * method.
34 *
35 * @param businessObjectClass - business object being queried on
36 * @param formProps - map of form properties
37 * @param unbounded - indicates if the search should be unbounded
38 * @param usePrimaryKeyValuesOnly - indicates if only primary key values should be used
39 * @return Object returned from the search
40 */
41 @Deprecated
42 public <T extends Object> Collection<T> findCollectionBySearchHelper(
43 Class<T> businessObjectClass, Map<String, String> formProps, boolean unbounded,
44 boolean usePrimaryKeyValuesOnly);
45
46 /**
47 * Retrieves a collection of objects for the businessObjectClass based on the other information passed into the
48 * method.
49 *
50 * @param businessObjectClass - business object being queried on
51 * @param formProps - map of form properties
52 * @param unbounded - indicates if the search should be unbounded
53 * @param usePrimaryKeyValuesOnly - indicates if only primary key values should be used
54 * @param searchResultsLimit - used to limit the number of items returned
55 * @return Object returned from the search
56 */
57 @Deprecated
58 public <T extends Object> Collection<T> findCollectionBySearchHelper(
59 Class<T> businessObjectClass, Map<String, String> formProps, boolean unbounded,
60 boolean usePrimaryKeyValuesOnly, Integer searchResultsLimit);
61
62 /**
63 * Retrieves a Object based on the search criteria, which should uniquely
64 * identify a record.
65 *
66 * @return Object returned from the search
67 */
68 @Deprecated
69 public <T extends Object> T findObjectByMap(Class<T> type, Map<String, String> formProps);
70
71 /**
72 * Returns a count of objects based on the given search parameters.
73 *
74 * @return Long returned from the search
75 */
76 public Long findCountByMap(Object example, Map<String, String> formProps);
77
78 /**
79 * Create OJB criteria based on business object, search field and value
80 *
81 * @return true if the criteria is created successfully; otherwise, return
82 * false
83 */
84 @Deprecated
85 public boolean createCriteria(Object example, String searchValue,
86 String propertyName, Object criteria);
87
88 /**
89 * Create OJB criteria based on business object, search field and value
90 *
91 * @return true if the criteria is created successfully; otherwise, return
92 * false
93 */
94 @Deprecated
95 public boolean createCriteria(Object example, String searchValue,
96 String propertyName, boolean caseInsensitive,
97 boolean treatWildcardsAndOperatorsAsLiteral, Object criteria);
98 }