1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.module.purap.util;
20
21 import org.kuali.kfs.module.purap.document.ReceivingDocument;
22
23 /**
24 * Receiving Question Callback
25 * Defines a callback method for post processing handling in the question interface.
26 */
27 public interface ReceivingQuestionCallback {
28
29 public boolean questionComplete = false;
30
31 /**
32 * Hooks for doing processing on the document after a question has been performed.
33 *
34 * @param document - receiving document
35 * @param noteText - user entered note
36 */
37 public ReceivingDocument doPostQuestion(ReceivingDocument document, String noteText) throws Exception;
38
39 /**
40 * Has the question been answered completely to move forward.
41 *
42 * @return
43 */
44 public boolean isQuestionComplete();
45
46 /**
47 * Setter for question complete
48 *
49 * @param questionComplete
50 * @return
51 */
52 public void setQuestionComplete(boolean questionComplete);
53
54 /**
55 * Setter for correction document note text
56 * @param noteText
57 */
58 public void setCorrectionDocumentCreationNoteText(String noteText);
59
60 /**
61 * Getter for correction document note text
62 */
63 public String getCorrectionDocumentCreationNoteText();
64 }