/*

  * Copyright 2005-2007 The Kuali Foundation

  * 

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  * 

  * http://www.opensource.org/licenses/ecl2.php

  * 

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kns.dao;

 import java.util.Collection;

 import java.util.Map;

 /**

  * This interface defines basic methods that Lookup Dao's must provide

  * 

  * 

  */

 public interface LookupDao {

     public Collection findCollectionBySearchHelper(Class example, Map formProps, boolean unbounded, boolean usePrimaryKeyValuesOnly);

     public Collection findCollectionBySearchHelper(Class example, Map formProps, boolean unbounded, boolean usePrimaryKeyValuesOnly, Object additionalCriteria );

     /**

      * Retrieves a Object based on the search criteria, which should uniquely identify a record.

      * 

      * @return Object returned from the search

      */

     public Object findObjectByMap(Object example, Map formProps);

     /**

      * Returns a count of objects based on the given search parameters.

      * 

      * @return Long returned from the search

      */

     public Long findCountByMap(Object example, Map formProps);

     /**

      * Create OJB criteria based on business object, search field and value

      * 

      * @return true if the criteria is created successfully; otherwise, return false

      */

     public boolean createCriteria(Object example, String searchValue, String propertyName, Object criteria);

     /**

      * Create OJB criteria based on business object, search field and value

      * 

      * @return true if the criteria is created successfully; otherwise, return false

      */

     public boolean createCriteria(Object example, String searchValue, String propertyName, boolean caseInsensitive, boolean treatWildcardsAndOperatorsAsLiteral, Object criteria);

 }