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

Class WcmSecurityWizardPage

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
  3. extended bycom.filenet.wcm.toolkit.server.base.WcmModule
  4. extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
  5. extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
  6. 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

  1. public class WcmSecurityWizardPage
  2. extends com.filenet.wcm.toolkit.server.base.WcmUiModule
  3. 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

Modifier and Type Field and Description
  1. protected
  2. boolean
bInited
  1. protected
  2. int
mode
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER

Constructor Summary

Constructor and Description
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

Modifier and Type Method and Description
  1. WcmSecurityInfoPage
getSecurityInfoPage()
Accessor method to return the WcmSecurityInfoPage object.
  1. java.util.Iterator
getValidationErrors()
  1. void
initialize()
Initializes the WcmSecurityWizardPage Module.
  1. boolean
isFinished()
Returns true to indicate the WcmSecurityWizardPage is ready to be flushed back to the repository.
  1. void
panelCancel(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
This method forwards the Cancel event to the WcmSecurityInfoPage for further handling.
  1. void
panelFinish(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
This method forwards the Finish event to the WcmSecurityInfoPage for further handling.
  1. void
panelInit()
This initalizes the WcmSecurityWizardPage and the WcmSecurityInfoPage.
  1. void
panelSave(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Interface method not use by the WcmSecurityWizardPage module.
  1. boolean
panelValidate()
Called on a page to check any entered data to confirm that everything is valid.
  1. void
render(java.io.Writer w)
Renders the WcmSecurityWizardPage module using XSLT and sent back to the client as the HTML user interface.
  1. 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

  1. protected boolean bInited

mode

  1. protected int mode

Constructor Detail

WcmSecurityWizardPage

  1. public WcmSecurityWizardPage(int mode)
  2. 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.
Throws:
java.lang.Exception

Method Detail

initialize

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

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

panelInit

  1. public void panelInit()
  2. 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:

panelCancel

  1. public void panelCancel(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. 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:

panelValidate

  1. public boolean panelValidate()
  2. 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
Returns:
true is valid
Throws:
java.lang.Exception

getValidationErrors

  1. public java.util.Iterator getValidationErrors( )
Description copied from interface: com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns validation errors
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
Iterator

panelSave

  1. public void panelSave(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. 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

  1. public void panelFinish(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. 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:

render

  1. public void render(java.io.Writer w)
  2. 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
Overrides:
render in class com.filenet.wcm.toolkit.server.base.WcmUiModule
Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.
See Also:

isFinished

  1. 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
Returns:
true or false

getSecurityInfoPage

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

setSecurityInfoPage

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