1 /*
2 * Copyright 2007-2008 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.ole.module.purap.util;
17
18 import org.kuali.ole.module.purap.document.ReceivingDocument;
19
20 /**
21 * Receiving Question Callback
22 * Defines a callback method for post processing handling in the question interface.
23 */
24 public interface ReceivingQuestionCallback {
25
26 public boolean questionComplete = false;
27
28 /**
29 * Hooks for doing processing on the document after a question has been performed.
30 *
31 * @param document - receiving document
32 * @param noteText - user entered note
33 */
34 public ReceivingDocument doPostQuestion(ReceivingDocument document, String noteText) throws Exception;
35
36 /**
37 * Has the question been answered completely to move forward.
38 *
39 * @return
40 */
41 public boolean isQuestionComplete();
42
43 /**
44 * Setter for question complete
45 *
46 * @param questionComplete
47 * @return
48 */
49 public void setQuestionComplete(boolean questionComplete);
50
51 /**
52 * Setter for correction document note text
53 *
54 * @param noteText
55 */
56 public void setCorrectionDocumentCreationNoteText(String noteText);
57
58 /**
59 * Getter for correction document note text
60 */
61 public String getCorrectionDocumentCreationNoteText();
62 }