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 java.awt.Component;
49
50 import javax.swing.JDialog;
51
52 import org.telscenter.pas.ui.frames.PasFrame;
53
54 /***
55 * @author aperritano
56 *
57 */
58 public interface INoteStep {
59
60 /***
61 * type of step
62 *
63 * @return
64 */
65 public String getType();
66
67 /***
68 * UI component
69 *
70 * @return
71 */
72 public Component getComponent();
73
74 /***
75 * step title
76 *
77 * @return
78 */
79 public String getTitle();
80
81 /***
82 * dialog for saving note
83 *
84 * @return
85 */
86 public JDialog showNoteSaveCheckDialog();
87
88 /***
89 * dialog for note checking note parts
90 *
91 * @return
92 */
93 public JDialog showNotePartsCheckDialog();
94
95 /***
96 * checking if the note is already one
97 *
98 * @return
99 */
100 public JDialog showNoteAlreadyOpenDialog();
101
102 /***
103 * checking if the note is already one
104 *
105 * @param pasFrame
106 */
107 public JDialog showNoteAlreadyOpenDialog(PasFrame pasFrame);
108
109 /***
110 * get the note ui
111 *
112 * @return
113 */
114 public INoteUI getNoteUI();
115
116
117
118 }