001    /**
002     * Copyright 2005-2012 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     */
016    package org.kuali.rice.krad.rules.rule;
017    
018    import org.kuali.rice.krad.bo.Note;
019    import org.kuali.rice.krad.document.Document;
020    
021    /**
022     * Defines a rule which gets invoked immediately before a document has a note added to it.
023     * 
024     * 
025     */
026    public interface AddNoteRule extends BusinessRule {
027        /**
028         * This method is responsible for housing business rules that need to be checked before a note is added to a document.
029         * 
030         * @param document
031         * @param note
032         * @return false if the rule fails
033         */
034        public boolean processAddNote(Document document, Note note);
035    }