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

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.toolkit.server.ui.WcmMultiPanelModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
                          extended bycom.filenet.wcm.apps.server.ui.WcmWizardModule
                              extended bycom.filenet.wcm.apps.server.ui.wizard.records.DeclareRecordsWizard
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class DeclareRecordsWizard
extends WcmWizardModule

This wizard is for adding a new object using an Entry Template. It has the potential of showing four pages: The folder selection page for choosing which folder to place the object, the property page for selecting the object class and setting properties, the security page for setting security on the new object, and finally if the object is of type document, the file selection page for choosing the file to add.


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
WcmWizardModule.WcmWizardPanel
 
Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  WcmAuthoringState authorState
           
protected  java.lang.String classificationPage
           
protected  DeclareRecordsClassificationWizardPage classificationsPage
           
protected  org.w3c.dom.Document domSelectedClassification
           
protected  com.filenet.wcm.toolkit.server.util.WcmEntryTemplate entryTemplate
           
protected  WcmNavigationState navState
           
protected  com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp
           
protected  java.lang.String propertiesPage
           
protected  DeclareRecordsPropertiesWizardPage propertyPage
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider rdp
           
protected  java.lang.String returnUrl
           
protected  com.filenet.wcm.toolkit.server.util.DeclareRecordsTemplate template
           
protected  WcmPropertiesUtil util
           
protected  int wizardType
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCancelText
           
protected static com.filenet.wcm.toolkit.util.WcmString wsClass
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDeclareRecords
           
protected static com.filenet.wcm.toolkit.util.WcmString wsEditable
           
protected static com.filenet.wcm.toolkit.util.WcmString wsHide
           
protected static com.filenet.wcm.toolkit.util.WcmString wsMarker
           
protected static com.filenet.wcm.toolkit.util.WcmString wsNone
           
protected static com.filenet.wcm.toolkit.util.WcmString wsNotSelected
           
protected static com.filenet.wcm.toolkit.util.WcmString wsReadonly
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
bannerModule, footerLinksBarModule, footerModule, leftCSSClass, stepNode, stepTreeModule, summaryModule, titleBarModule
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
controller, sequenceInit
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
currentModule, currentPanel, currentPanelNumber, panelList
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
DeclareRecordsWizard()
          Constructor
 
Method Summary
 void cleanup()
           
protected  void configureSummary()
          Adds the appropriate status information to the summary module
 void initialize()
          This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called in response to a cancel wizard request.
 void onFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Helper method called in onFinish event handler.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event, calling WcmController.setHelpContext for the current page.
protected  void updatedPropertyDescriptions(java.lang.String fpos, java.lang.String classId)
          Helper method that retrieves the Property Descriptions from the Content Engine and updates the specified meta data (required/Hidden/Editable/Default Values) from the Property descritpion information in the entry template.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
addPanel, addPanelSelectionAnchor, addSummaryItem, addSummaryItem, getAnchor, getAnchor, getFooter, getPageBanner, getSummaryModule, getTabBar, getTextLinksBar, isBackEnabled, isFinishEnabled, isNextEnabled, isPanelEnabled, okayToProceed, onSelectPanel, render, setCancelLinkText, setCurrentPanelSelection, setFinishLinkText, setIsFinished, setMultiPanelModuleTitle, setNextLinkText, setPreviousLinkText
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
cancelAll, onNext, onPrevious, selectPanel, selectPanel
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, selectPanel, setMultiPanelModuleTitle, setMultiPanelModuleTitle
 
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

wsDeclareRecords

protected static final com.filenet.wcm.toolkit.util.WcmString wsDeclareRecords

wsCancelText

protected static final com.filenet.wcm.toolkit.util.WcmString wsCancelText

wsClass

protected static final com.filenet.wcm.toolkit.util.WcmString wsClass

wsNone

protected static final com.filenet.wcm.toolkit.util.WcmString wsNone

wsNotSelected

protected static final com.filenet.wcm.toolkit.util.WcmString wsNotSelected

wsMarker

protected static final com.filenet.wcm.toolkit.util.WcmString wsMarker

wsEditable

protected static final com.filenet.wcm.toolkit.util.WcmString wsEditable

wsReadonly

protected static final com.filenet.wcm.toolkit.util.WcmString wsReadonly

wsHide

protected static final com.filenet.wcm.toolkit.util.WcmString wsHide

adp

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

ndp

protected com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp

rdp

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

authorState

protected WcmAuthoringState authorState

navState

protected WcmNavigationState navState

template

protected com.filenet.wcm.toolkit.server.util.DeclareRecordsTemplate template

entryTemplate

protected com.filenet.wcm.toolkit.server.util.WcmEntryTemplate entryTemplate

returnUrl

protected java.lang.String returnUrl

domSelectedClassification

protected org.w3c.dom.Document domSelectedClassification

util

protected WcmPropertiesUtil util

classificationsPage

protected DeclareRecordsClassificationWizardPage classificationsPage

propertyPage

protected DeclareRecordsPropertiesWizardPage propertyPage

propertiesPage

protected java.lang.String propertiesPage

classificationPage

protected java.lang.String classificationPage

wizardType

protected int wizardType
Constructor Detail

DeclareRecordsWizard

public DeclareRecordsWizard()
                     throws java.lang.Exception
Constructor

Throws:
java.lang.Exception - If there were problems constructing.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
This method queries for the Authoring and Navigation data providers, then adds each page to the wizard. It also sets the wizard tab and the return Url.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmWizardModule
Throws:
java.lang.Exception - If a data provider was not found.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Description copied from class: WcmWizardModule
The default event, calling WcmController.setHelpContext for the current page.

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

updatedPropertyDescriptions

protected void updatedPropertyDescriptions(java.lang.String fpos,
                                           java.lang.String classId)
                                    throws java.lang.Exception
Helper method that retrieves the Property Descriptions from the Content Engine and updates the specified meta data (required/Hidden/Editable/Default Values) from the Property descritpion information in the entry template. A reload is necessary to capture any changes in the list of class properties or choices list values.

Parameters:
fpos - String file plan object store name
classId - String holding class id
Throws:
java.lang.Exception

configureSummary

protected void configureSummary()
                         throws java.lang.Exception
Adds the appropriate status information to the summary module

Overrides:
configureSummary in class WcmWizardModule
Throws:
java.lang.Exception - If there were retrieving data.

onCancel

public void onCancel(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Called in response to a cancel wizard request. It releases module properties and calls the base class method.

Parameters:
request - The Java™Server Pages (JSP) request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

onFinish

public void onFinish(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Helper method called in onFinish event handler. Configres and calls confirmation page if necessary.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

cleanup

public void cleanup()
             throws java.lang.Exception
Throws:
java.lang.Exception


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