com.netscape.cms.servlet.wizard
Interface IWizardPanel

All Known Implementing Classes:
AdminAuthenticatePanel, AdminPanel, AgentAuthenticatePanel, AuthenticatePanel, BackupKeyCertPanel, CAInfoPanel, CertPrettyPrintPanel, CertRequestPanel, ConfigHSMLoginPanel, CreateSubsystemPanel, DatabasePanel, DisplayCertChainPanel, DonePanel, HierarchyPanel, ImportAdminCertPanel, ImportCAChainPanel, ModulePanel, NamePanel, RestoreKeyCertPanel, SavePKCS12Panel, SecurityDomainPanel, SizePanel, WelcomePanel, WizardPanelBase

public interface IWizardPanel


Method Summary
 void cleanUp()
          Cleans up panel so that isPanelDone returns false
 void display(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context context)
          Display the panel.
 void displayError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context context)
          If validiate() returns false, this method will be called.
 java.lang.String getId()
           
 java.lang.String getName()
           
 int getPanelNo()
           
 PropertySet getUsage()
           
 boolean hasSubPanel()
          has subPanels?
 void init(javax.servlet.ServletConfig config, int panelno)
          Initializes this panel.
 void init(WizardServlet servlet, javax.servlet.ServletConfig config, int panelno, java.lang.String id)
           
 boolean isLoopbackPanel()
           
 boolean isPanelDone()
          Is this panel done
 boolean isSubPanel()
          Is this a subPanel?
 void setId(java.lang.String id)
           
 boolean shouldSkip()
          Should we skip this panel to the next one?
 boolean showApplyButton()
          Show "Apply" button on frame?
 void update(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context context)
          Commit parameter changes
 void validate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context context)
          Checks if the given parameters are valid.
 

Method Detail

init

void init(javax.servlet.ServletConfig config,
          int panelno)
          throws javax.servlet.ServletException
Initializes this panel.

Throws:
javax.servlet.ServletException

init

void init(WizardServlet servlet,
          javax.servlet.ServletConfig config,
          int panelno,
          java.lang.String id)
          throws javax.servlet.ServletException
Throws:
javax.servlet.ServletException

getName

java.lang.String getName()

getPanelNo

int getPanelNo()

setId

void setId(java.lang.String id)

getId

java.lang.String getId()

getUsage

PropertySet getUsage()

shouldSkip

boolean shouldSkip()
Should we skip this panel to the next one?


cleanUp

void cleanUp()
             throws java.io.IOException
Cleans up panel so that isPanelDone returns false

Throws:
java.io.IOException

isPanelDone

boolean isPanelDone()
Is this panel done


showApplyButton

boolean showApplyButton()
Show "Apply" button on frame?


isSubPanel

boolean isSubPanel()
Is this a subPanel?


isLoopbackPanel

boolean isLoopbackPanel()

hasSubPanel

boolean hasSubPanel()
has subPanels?


display

void display(javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response,
             org.apache.velocity.context.Context context)
Display the panel.


validate

void validate(javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response,
              org.apache.velocity.context.Context context)
              throws java.io.IOException
Checks if the given parameters are valid.

Throws:
java.io.IOException

update

void update(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response,
            org.apache.velocity.context.Context context)
            throws java.io.IOException
Commit parameter changes

Throws:
java.io.IOException

displayError

void displayError(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  org.apache.velocity.context.Context context)
If validiate() returns false, this method will be called.