001/**
002 * Copyright 2005-2016 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.container;
017
018import org.kuali.rice.krad.uif.view.View;
019
020import java.io.Serializable;
021import java.util.List;
022
023/**
024 * Provides filtering on collection data within a <code>CollectionGroup</code>
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028public interface CollectionFilter extends Serializable {
029
030    /**
031     * Invoked to filter the collection data before the collection group is
032     * built. Note the collection should be retrieved from the model and the valid
033     * row indexes must be returned in the return list
034     *
035     * @param view - view instance for the collection group
036     * @param model - object containing the view data and from which the collection should be pulled/updated
037     * @param collectionGroup - collection group instance containing configuration for the collection
038     * @return the list that contains valid row indexes
039     */
040    public List<Integer> filter(View view, Object model, CollectionGroup collectionGroup);
041}