1 /*
2 * Copyright 2005-2007 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.kns.dao;
17
18 import java.util.Collection;
19 import java.util.Map;
20
21 /**
22 * This interface defines basic methods that Lookup Dao's must provide
23 *
24 *
25 */
26 public interface LookupDao {
27 public Collection findCollectionBySearchHelper(Class example, Map formProps, boolean unbounded, boolean usePrimaryKeyValuesOnly);
28
29 public Collection findCollectionBySearchHelper(Class example, Map formProps, boolean unbounded, boolean usePrimaryKeyValuesOnly, Object additionalCriteria );
30
31 /**
32 * Retrieves a Object based on the search criteria, which should uniquely identify a record.
33 *
34 * @return Object returned from the search
35 */
36 public Object findObjectByMap(Object example, Map formProps);
37
38 /**
39 * Returns a count of objects based on the given search parameters.
40 *
41 * @return Long returned from the search
42 */
43 public Long findCountByMap(Object example, Map formProps);
44
45 /**
46 * Create OJB criteria based on business object, search field and value
47 *
48 * @return true if the criteria is created successfully; otherwise, return false
49 */
50 public boolean createCriteria(Object example, String searchValue, String propertyName, Object criteria);
51
52 /**
53 * Create OJB criteria based on business object, search field and value
54 *
55 * @return true if the criteria is created successfully; otherwise, return false
56 */
57 public boolean createCriteria(Object example, String searchValue, String propertyName, boolean caseInsensitive, boolean treatWildcardsAndOperatorsAsLiteral, Object criteria);
58 }