1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.cms.servlet.wizard;
import java.io.IOException;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.velocity.context.Context;
import com.netscape.certsrv.property.PropertySet;
public interface IWizardPanel {
/**
* Initializes this panel.
*/
public void init(ServletConfig config, int panelno)
throws ServletException;
public void init(WizardServlet servlet, ServletConfig config,
int panelno, String id) throws ServletException;
public String getName();
public int getPanelNo();
public void setId(String id);
public String getId();
public PropertySet getUsage();
/**
* Should we skip this panel to the next one?
*/
public boolean shouldSkip();
/**
* Cleans up panel so that isPanelDone returns false
*/
public void cleanUp() throws IOException;
/**
* Is this panel done
*/
public boolean isPanelDone();
/**
* Show "Apply" button on frame?
*/
public boolean showApplyButton();
/**
* Is this a subPanel?
*/
public boolean isSubPanel();
public boolean isLoopbackPanel();
/**
* has subPanels?
*/
public boolean hasSubPanel();
/**
* Display the panel.
*/
public void display(HttpServletRequest request,
HttpServletResponse response,
Context context);
/**
* Checks if the given parameters are valid.
*/
public void validate(HttpServletRequest request,
HttpServletResponse response,
Context context) throws IOException;
/**
* Commit parameter changes
*/
public void update(HttpServletRequest request,
HttpServletResponse response,
Context context) throws IOException;
/**
* If validiate() returns false, this method will be called.
*/
public void displayError(HttpServletRequest request,
HttpServletResponse response,
Context context);
}
|