001    /*
002     * Copyright 2011 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.kfs.sys.document.validation.event;
017    
018    import org.kuali.rice.kns.bo.Note;
019    import org.kuali.rice.kns.document.Document;
020    
021    /**
022     * An attributed version of the Add Note event.
023     */
024    public class AttributedAddNoteEvent extends AttributedDocumentEventBase {
025        private Note note;
026    
027        /**
028         * Constructs an AddNoteEvent with the specified errorPathPrefix and document
029         * 
030         * @param document
031         * @param errorPathPrefix
032         */
033        public AttributedAddNoteEvent(String errorPathPrefix, Document document, Note note) {
034            super("creating add note event for document " + getDocumentId(document), errorPathPrefix, document);
035            this.note = note;
036        }
037    
038        /**
039         * Constructs an AddNoteEvent with the given document
040         * 
041         * @param document
042         */
043        public AttributedAddNoteEvent(Document document, Note note) {
044            this("", document, note);
045        }
046    
047        /**
048         * This method retrieves the note associated with this event.
049         * 
050         * @return
051         */
052        public Note getNote() {
053            return note;
054        }
055    }