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.module.purap.util;
017    
018    import org.kuali.kfs.module.purap.document.ReceivingDocument;
019    
020    /**
021     * Receiving Question Callback
022     * Defines a callback method for post processing handling in the question interface.
023     */
024    public interface ReceivingQuestionCallback {
025    
026        public boolean questionComplete = false;
027        
028        /**
029         * Hooks for doing processing on the document after a question has been performed.
030         * 
031         * @param document - receiving document
032         * @param noteText - user entered note
033         */
034        public ReceivingDocument doPostQuestion(ReceivingDocument document, String noteText) throws Exception;
035        
036        /**
037         * Has the question been answered completely to move forward.
038         * 
039         * @return
040         */
041        public boolean isQuestionComplete();
042        
043        /**
044         * Setter for question complete
045         * 
046         * @param questionComplete
047         * @return
048         */
049        public void setQuestionComplete(boolean questionComplete);
050        
051        /**
052         * Setter for correction document note text
053         * @param noteText
054         */
055        public void setCorrectionDocumentCreationNoteText(String noteText);
056        
057        /**
058         * Getter for correction document note text
059         */
060        public String getCorrectionDocumentCreationNoteText();
061    }