001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.dao;
017
018import org.kuali.rice.krad.util.LegacyDataFramework;
019
020import java.util.Collection;
021import java.util.Map;
022
023/**
024 * Defines basic methods that Lookup Dao's must provide
025 * @deprecated use new KRAD Data framework {@link org.kuali.rice.krad.data.DataObjectService}
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028@Deprecated
029@LegacyDataFramework
030public interface LookupDao {
031    /**
032     * Retrieves a collection of objects for the businessObjectClass based on the other information passed into the
033     * method.
034     *
035     * @param businessObjectClass - business object being queried on
036     * @param formProps - map of form properties
037     * @param unbounded - indicates if the search should be unbounded
038     * @param usePrimaryKeyValuesOnly - indicates if only primary key values should be used
039     * @return Object returned from the search
040     */
041    @Deprecated
042        public <T extends Object> Collection<T> findCollectionBySearchHelper(
043                        Class<T> businessObjectClass, Map<String, String> formProps, boolean unbounded,
044                        boolean usePrimaryKeyValuesOnly);
045
046    /**
047     * Retrieves a collection of objects for the businessObjectClass based on the other information passed into the
048     * method.
049     *
050     * @param businessObjectClass - business object being queried on
051     * @param formProps - map of form properties
052     * @param unbounded - indicates if the search should be unbounded
053     * @param usePrimaryKeyValuesOnly - indicates if only primary key values should be used
054     * @param searchResultsLimit - used to limit the number of items returned
055     * @return Object returned from the search
056     */
057    @Deprecated
058    public <T extends Object> Collection<T> findCollectionBySearchHelper(
059            Class<T> businessObjectClass, Map<String, String> formProps, boolean unbounded,
060            boolean usePrimaryKeyValuesOnly, Integer searchResultsLimit);
061
062        /**
063         * Retrieves a Object based on the search criteria, which should uniquely
064         * identify a record.
065         * 
066         * @return Object returned from the search
067         */
068    @Deprecated
069        public <T extends Object> T findObjectByMap(Class<T> type, Map<String, String> formProps);
070
071        /**
072         * Returns a count of objects based on the given search parameters.
073         * 
074         * @return Long returned from the search
075         */
076        public Long findCountByMap(Object example, Map<String, String> formProps);
077
078        /**
079         * Create OJB criteria based on business object, search field and value
080         * 
081         * @return true if the criteria is created successfully; otherwise, return
082         *         false
083         */
084    @Deprecated
085        public boolean createCriteria(Object example, String searchValue,
086                        String propertyName, Object criteria);
087
088        /**
089         * Create OJB criteria based on business object, search field and value
090         * 
091         * @return true if the criteria is created successfully; otherwise, return
092         *         false
093         */
094    @Deprecated
095        public boolean createCriteria(Object example, String searchValue,
096                        String propertyName, boolean caseInsensitive,
097                        boolean treatWildcardsAndOperatorsAsLiteral, Object criteria);
098}