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.rules.rule;
017
018import org.kuali.rice.krad.rules.rule.event.AddCollectionLineEvent;
019
020/**
021 * Defines a rule which gets invoked immediately before an object is added to a collection.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public interface AddCollectionLineRule extends BusinessRule {
026
027    /**
028     * Run the rules associated with adding an object to a collection.
029     *
030     * @param addEvent the event containing all of the object necessary to run the rules
031     *
032     * @return true if validation succeeds, false otherwise
033     */
034    boolean processAddCollectionLine(AddCollectionLineEvent addEvent);
035}