com.filenet.wcm.apps.server.ui.wizard.records
Class RMPropertiesWizardPage

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.records.RMPropertiesWizardPage
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

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


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  WcmAuthoringState authorState
           
protected  java.lang.String className
           
protected  WcmEditPage editPage
           
protected  int nType
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider rdp
           
protected  RMRecordsClassInfoPage ui
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
RMPropertiesWizardPage(int type)
          Constructor calls base class constructor, then creates the required pages.
 
Method Summary
 void cleanup()
          Clean up
 WcmEditPage getEditPage()
          Get accessor returns WcmEditPage
 java.lang.String getFormName()
          Uses the WcmPropertiesInfoPage form so wizard navigation will submit it.
 org.w3c.dom.NodeList getPropDescs()
          Return property description's node list.
 RMRecordsClassInfoPage getPropertiesInfoPage()
          Get accessor returns RMRecordsClassInfoPage
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 boolean isFinished()
          Defers to the WcmPropertiesInfoPage.
 java.lang.String onGetLocation(java.lang.String objectStoreName)
           
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler.
 void onShowProps(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show/Hide Properties was pressed.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the Classes
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears state information.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Should not be called.
 void panelInit()
          Called when this wizard page is first loaded to clear out any residual state information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sends wizardSave to the WcmPropertiesInfoPage.
 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 document classes and properties.
protected  void restorePropObject()
           
protected  void savePropObject()
          No need to clear out property description or value in specific property key since no module will overide those property.
 void setPropertiesInfoPage(RMRecordsClassInfoPage ui)
          Set accessor of RMRecordsClassInfoPage
 
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, 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
subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, 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.WcmModuleInterface
addDataProvider, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

rdp

protected com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider rdp

authorState

protected WcmAuthoringState authorState

editPage

protected WcmEditPage editPage

ui

protected RMRecordsClassInfoPage ui

nType

protected int nType

className

protected java.lang.String className
Constructor Detail

RMPropertiesWizardPage

public RMPropertiesWizardPage(int type)
                       throws java.lang.Exception
Constructor calls base class constructor, then creates the required pages.

Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes data providers, XSL parameters, the authoring state, and other state values.

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

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Initialize the Classes

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the document classes and properties.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write to.
Throws:
java.lang.Exception

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Select event handler. This method use Chain of Responsibility pattern to route form data to related module.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onShowProps

public void onShowProps(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Show/Hide Properties was pressed. Toggles the state of showing properties.

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

panelInit

public void panelInit()
               throws java.lang.Exception
Called when this wizard page is first loaded to clear out any residual state information.

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

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Clears state information.

Specified by:
panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Sends wizardSave to the WcmPropertiesInfoPage.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

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

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Should not be called. Currently clears state information.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Defers to the WcmPropertiesInfoPage.

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Returns:
WcmPropertiesInfoPage.isFinished.
Throws:
java.lang.Exception

getFormName

public java.lang.String getFormName()
Uses the WcmPropertiesInfoPage form so wizard navigation will submit it.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Returns:
ui.getFormName.

getPropDescs

public org.w3c.dom.NodeList getPropDescs()
                                  throws java.lang.Exception
Return property description's node list. Use Properties and property descriptions dom to create this new property descrption node list. propdef tag is going to have values and value tags under it if it is a multi-value object.

Throws:
java.lang.Exception

getPropertiesInfoPage

public RMRecordsClassInfoPage getPropertiesInfoPage()
                                             throws java.lang.Exception
Get accessor returns RMRecordsClassInfoPage

Returns:
WcmPropertiesInfoPage
Throws:
java.lang.Exception

setPropertiesInfoPage

public void setPropertiesInfoPage(RMRecordsClassInfoPage ui)
                           throws java.lang.Exception
Set accessor of RMRecordsClassInfoPage

Throws:
java.lang.Exception

getEditPage

public WcmEditPage getEditPage()
                        throws java.lang.Exception
Get accessor returns WcmEditPage

Returns:
WcmEditPage
Throws:
java.lang.Exception

onGetLocation

public java.lang.String onGetLocation(java.lang.String objectStoreName)
                               throws java.lang.Exception
Throws:
java.lang.Exception

restorePropObject

protected void restorePropObject()
                          throws java.lang.Exception
Throws:
java.lang.Exception

savePropObject

protected void savePropObject()
                       throws java.lang.Exception
No need to clear out property description or value in specific property key since no module will overide those property.

Throws:
java.lang.Exception

cleanup

public void cleanup()
             throws java.lang.Exception
Clean up

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


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