com.filenet.wcm.apps.server.ui.wizard
Class WcmSecurityWizardPage

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.apps.server.ui.wizard.WcmSecurityWizardPage
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface, com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
WcmEntryDesignerSecurityWizardPage, WcmEntrySecurityWizardPage, WcmEntryTempSecurityWizardPage

public class WcmSecurityWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

The WcmSecurityWizardPage module displays the security for document, folder, and/or stored search objects in a wizard page for adding a new document/folder or checking in a document.

See Also:
WcmSecurityInfoPage

Field Summary
protected  boolean bInited
           
protected  int mode
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmSecurityWizardPage(int mode)
          Creates a new WcmSecurityWizardPage object for the wizard page navigation and initializes its mode to one of the static int values defined by the WcmWizardPageInterface.
 
Method Summary
 WcmSecurityInfoPage getSecurityInfoPage()
          Accessor method to return the WcmSecurityInfoPage object.
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes the WcmSecurityWizardPage Module.
 boolean isFinished()
          Returns true to indicate the WcmSecurityWizardPage is ready to be flushed back to the repository.
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This method forwards the Cancel event to the WcmSecurityInfoPage for further handling.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This method forwards the Finish event to the WcmSecurityInfoPage for further handling.
 void panelInit()
          This initalizes the WcmSecurityWizardPage and the WcmSecurityInfoPage.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Interface method not use by the WcmSecurityWizardPage module.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void render(java.io.Writer w)
          Renders the WcmSecurityWizardPage module using XSLT and sent back to the client as the HTML user interface.
 void setSecurityInfoPage(WcmSecurityInfoPage newSecurityUi)
          Accessor method to set the WcmSecurityInfoPage object.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
onStartPage, subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
onStartPage
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

bInited

protected boolean bInited

mode

protected int mode
Constructor Detail

WcmSecurityWizardPage

public WcmSecurityWizardPage(int mode)
                      throws java.lang.Exception
Creates a new WcmSecurityWizardPage object for the wizard page navigation and initializes its mode to one of the static int values defined by the WcmWizardPageInterface.

Parameters:
mode - int specifying the operation mode.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the WcmSecurityWizardPage Module.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - All errors.

panelInit

public void panelInit()
               throws java.lang.Exception
This initalizes the WcmSecurityWizardPage and the WcmSecurityInfoPage. This event only happens once at the start of the wizard process.

Specified by:
panelInit in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Throws:
java.lang.Exception - All errors.
See Also:
WcmSecurityInfoPage

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
This method forwards the Cancel event to the WcmSecurityInfoPage for further handling.

Specified by:
panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Parameters:
request - The Java™Server Pages (JSP) request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.
See Also:
WcmSecurityInfoPage

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Throws:
java.lang.Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Interface method not use by the WcmSecurityWizardPage module.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
This method forwards the Finish event to the WcmSecurityInfoPage for further handling.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.
See Also:
WcmSecurityInfoPage

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the WcmSecurityWizardPage module using XSLT and sent back to the client as the HTML user interface.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.
See Also:
WcmSecurityInfoPage

isFinished

public boolean isFinished()
Returns true to indicate the WcmSecurityWizardPage is ready to be flushed back to the repository.

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

getSecurityInfoPage

public WcmSecurityInfoPage getSecurityInfoPage()
Accessor method to return the WcmSecurityInfoPage object.

Returns:
WcmSecurityInfoPage object.

setSecurityInfoPage

public void setSecurityInfoPage(WcmSecurityInfoPage newSecurityUi)
Accessor method to set the WcmSecurityInfoPage object.



© Copyright IBM Corp. 2002, 2007. All Rights Reserved.