1 /***
2 * Copyright (c) 2007 Regents of the University of California (Regents). Created
3 * by TELS, Graduate School of Education, University of California at Berkeley.
4 *
5 * This software is distributed under the GNU Lesser General Public License, v2.
6 *
7 * Permission is hereby granted, without written agreement and without license
8 * or royalty fees, to use, copy, modify, and distribute this software and its
9 * documentation for any purpose, provided that the above copyright notice and
10 * the following two paragraphs appear in all copies of this software.
11 *
12 * REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
13 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
14 * PURPOSE. THE SOFTWAREAND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED
15 * HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE
16 * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 *
18 * IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
19 * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
20 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
21 * REGENTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22 */
23
24 /***
25 * Copyright (c) 2007 Regents of the University of California (Regents). Created
26 * by TELS, Graduate School of Education, University of California at Berkeley.
27 *
28 * This software is distributed under the GNU Lesser General Public License, v2.
29 *
30 * Permission is hereby granted, without written agreement and without license
31 * or royalty fees, to use, copy, modify, and distribute this software and its
32 * documentation for any purpose, provided that the above copyright notice and
33 * the following two paragraphs appear in all copies of this software.
34 *
35 * REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
36 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
37 * PURPOSE. THE SOFTWAREAND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED
38 * HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE
39 * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
40 *
41 * IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
42 * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
43 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
44 * REGENTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 */
46 package org.telscenter.pas.steps;
47
48 import javax.swing.JDialog;
49
50 import org.telscenter.pas.steps.actions.NoteSaveAction;
51
52 /***
53 * @author aperritano
54 *
55 */
56 public interface INoteUI extends IQtiStepUI {
57
58 /***
59 * Shows the save dialog
60 *
61 * @return
62 */
63 public JDialog showNoteSaveCheckDialog();
64
65 /***
66 * checks if you filled in all the fields
67 *
68 * @return
69 */
70 public JDialog showNotePartsCheckDialog();
71
72 /***
73 * checks for already open notes
74 *
75 * @return
76 */
77 public JDialog showNoteAlreadyOpenDialog();
78
79 /***
80 * @return the noteOpen
81 */
82 public boolean isNoteOpen();
83
84 /***
85 * flag for is this Note open
86 *
87 * @param noteOpen
88 * the noteOpen to set
89 */
90 public void setNoteOpen(boolean openedNote);
91
92 /***
93 * get the save action
94 *
95 * TODO maybe get rid of this (made for incremental refactoring)
96 *
97 * @return
98 */
99 public NoteSaveAction getSaveAction();
100
101 /***
102 * flags that the note has been saved.
103 *
104 * @param noteSaveConfirmed
105 */
106 public void setNoteSaveConfirmed(boolean noteSaveConfirmed);
107
108 /***
109 * getter
110 *
111 * @return
112 */
113 public boolean getNoteSaveConfirmed();
114
115 /***
116 * getter
117 *
118 * @return
119 */
120 public boolean getNoteSavePartsConfirmed();
121
122 /***
123 * sets it save a part of the note
124 *
125 * @param b
126 */
127 public void setNoteSavePartsConfirmed(boolean b);
128
129 }