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.uif.control;
017
018import java.util.Map;
019
020/**
021 * Control instance that implements a callback for processing lookup search criteria.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public interface FilterableLookupCriteriaControl {
026
027    /**
028     * Returns the post data for the filterable lookup criteria control using the property name as a key.
029     *
030     * @param propertyName the property name for the control
031     *
032     * @return the post data for the filterable lookup criteria control
033     */
034    FilterableLookupCriteriaControlPostData getPostData(String propertyName);
035
036    /**
037     * Invoked to perform filtering of the search criteria.
038     *
039     * @param propertyName the propertyName of the current component
040     * @param searchCriteria the search criteria to be filtered
041     * @param postData the post data to consider during the search
042     *
043     * @return filtered search criteria
044     */
045    Map<String, String> filterSearchCriteria(String propertyName, Map<String, String> searchCriteria, FilterableLookupCriteriaControlPostData postData);
046
047}