View Javadoc

1   /**
2    * Copyright 2005-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.rules.rule;
17  
18  import org.kuali.rice.krad.bo.Note;
19  import org.kuali.rice.krad.document.Document;
20  
21  /**
22   * Defines a rule which gets invoked immediately before a document has a note added to it.
23   *
24   *
25   */
26  public interface AddNoteRule extends BusinessRule {
27      /**
28       * This method is responsible for housing business rules that need to be checked before a note is added to a document.
29       *
30       * @param document
31       * @param note
32       * @return false if the rule fails
33       */
34      public boolean processAddNote(Document document, Note note);
35  }