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.db.config.profile;
017
018import org.kuali.common.util.metainf.spring.MetaInfDataLocation;
019import org.kuali.common.util.metainf.spring.MetaInfDataType;
020import org.kuali.common.util.metainf.spring.MetaInfGroup;
021
022import java.util.List;
023
024/**
025 * Applies a filter to the combination of a {@link MetaInfGroup}, a {@link MetaInfDataLocation}, and a
026 * {@link MetaInfDataType} data set.
027 *
028 * TODO: Push to kuali-util
029 */
030public interface MetaInfFilterConfig {
031
032    /**
033     * Returns whether to include the data for the {@link MetaInfGroup}, {@link MetaInfDataLocation}, and
034     * {@link MetaInfDataType}.
035     *
036     * @param group the {link MetaInfGroup} to check
037     * @param location the {@link MetaInfDataLocation} to check
038     * @param type the {@link MetaInfDataType} to check
039     *
040     * @return true if the data set should be included, false otherwise
041     */
042    boolean isIncluded(MetaInfGroup group, MetaInfDataLocation location, MetaInfDataType type);
043
044    /**
045     * Returns whether to exclude the data for the {@link MetaInfGroup}, {@link MetaInfDataLocation}, and
046     * {@link MetaInfDataType}.
047     *
048     * @param group the {link MetaInfGroup} to check
049     * @param location the {@link MetaInfDataLocation} to check
050     * @param type the {@link MetaInfDataType} to check
051     *
052     * @return true if the data set should be excluded, false otherwise
053     */
054    boolean isExcluded(MetaInfGroup group, MetaInfDataLocation location, MetaInfDataType type);
055
056}