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

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.RecordsTemplateDesignerWizard
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class RecordsTemplateDesignerWizard
extends WcmWizardModule


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
           
static java.lang.String AUTH_STATE_KEY
           
protected  WcmAuthoringState authorState
           
protected  org.w3c.dom.Document domSelectedClassification
           
protected  WcmEntryTempFolderWizardPage folderAddEntryPage
           
static java.lang.String MODE_ADD
           
static java.lang.String MODE_MODIFY
           
static java.lang.String NAVI_STATE_KEY
           
protected  WcmNavigationState navState
           
protected  com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp
           
protected  RMTempPropertiesWizardPage propertyAddEntryPage
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider rdp
           
protected  RMClassificationWizardPage rmClassificationPage
           
protected  RMPropertiesWizardPage rmPropertiesPage
           
protected  com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode rootNode
           
protected  com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode saveRootNode
           
protected  WcmEntryTempSecurityWizardPage securityAddEntryPage
           
protected  java.lang.String sMode
           
protected  java.lang.String sType
           
protected  com.filenet.wcm.toolkit.server.util.DeclareRecordsTemplate template
           
protected  com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode templateRootNode
           
protected  java.util.Hashtable templateWizard
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCancelAddText
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCancelModText
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDeclareRecord
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDocumentClass
           
protected static com.filenet.wcm.toolkit.util.WcmString wsEditable
           
protected static com.filenet.wcm.toolkit.util.WcmString wsEntryClass
           
protected static com.filenet.wcm.toolkit.util.WcmString wsFinishText
           
protected static com.filenet.wcm.toolkit.util.WcmString wsFolder
           
protected static com.filenet.wcm.toolkit.util.WcmString wsHide
           
protected static com.filenet.wcm.toolkit.util.WcmString wsModifySteps
           
protected static com.filenet.wcm.toolkit.util.WcmString wsModifyTitle
           
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
           
protected static com.filenet.wcm.toolkit.util.WcmString wsRecordClass
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSaveSteps
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSteps
           
 
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
RecordsTemplateDesignerWizard()
           
 
Method Summary
protected  void addPanelSelectionAnchor(int panelNumber)
           
 void cleanup()
          Clean up module cached data.
protected  void configureAddEntryFolderSelectionPage()
          Setup the Add Entry folder selection page
protected  void configureAddEntryPropertiesSelectionPage()
          Setup the Add Entry properties selection page
protected  void configureAddEntrySecuritySelectionPage()
          Setup the Add Entry security selection page
protected  void configureRMClassificaitonSelectPage()
          Setup the RM Classification selection page
protected  void configureRMPropertiesPage()
          Setup the Properties page
protected  void configureSummary()
          Writes the actual contents of the status bar.
 RMClassificationWizardPage getRMClassificationWizardPage()
          Get accessor returns RMClassificationWizardPage
 RMPropertiesWizardPage getRMPropertiesWizardPage()
          Get accessor returns RMPropertiesWizardPage
 void initialize()
          This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
protected  void initialStateData()
          Initialize state data
 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)
          When Finish button is pressed, add the folder as requested.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the Classes
protected  boolean saveModuleProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int panelNumber, boolean skip)
          Save module properties if user did not select those page then we have force to save its content back to entry template
protected  void setIsFinished()
          Goes through the pages and sets the isFinished member of WcmPage
 void setMode(java.lang.String mode)
          Indicate what mode this module is working at
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
addPanel, addSummaryItem, addSummaryItem, getAnchor, getAnchor, getFooter, getPageBanner, getSummaryModule, getTabBar, getTextLinksBar, isBackEnabled, isFinishEnabled, isNextEnabled, isPanelEnabled, okayToProceed, onSelectPanel, render, setCancelLinkText, setCurrentPanelSelection, setFinishLinkText, 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

MODE_ADD

public static final java.lang.String MODE_ADD
See Also:
Constant Field Values

MODE_MODIFY

public static final java.lang.String MODE_MODIFY
See Also:
Constant Field Values

AUTH_STATE_KEY

public static final java.lang.String AUTH_STATE_KEY
See Also:
Constant Field Values

NAVI_STATE_KEY

public static final java.lang.String NAVI_STATE_KEY
See Also:
Constant Field Values

wsAddTitle

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

wsModifyTitle

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

wsRecordClass

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

wsFolder

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

wsDocumentClass

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

wsNone

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

wsSteps

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

wsModifySteps

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

wsDeclareRecord

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

wsSaveSteps

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

wsEntryClass

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

wsNotSelected

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

wsCancelAddText

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

wsCancelModText

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

wsFinishText

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

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

navState

protected WcmNavigationState navState

authorState

protected WcmAuthoringState authorState

rmClassificationPage

protected RMClassificationWizardPage rmClassificationPage

rmPropertiesPage

protected RMPropertiesWizardPage rmPropertiesPage

folderAddEntryPage

protected WcmEntryTempFolderWizardPage folderAddEntryPage

propertyAddEntryPage

protected RMTempPropertiesWizardPage propertyAddEntryPage

securityAddEntryPage

protected WcmEntryTempSecurityWizardPage securityAddEntryPage

template

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

sMode

protected java.lang.String sMode

sType

protected java.lang.String sType

domSelectedClassification

protected org.w3c.dom.Document domSelectedClassification

templateWizard

protected java.util.Hashtable templateWizard

rootNode

protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode rootNode

templateRootNode

protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode templateRootNode

saveRootNode

protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode saveRootNode
Constructor Detail

RecordsTemplateDesignerWizard

public RecordsTemplateDesignerWizard()
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 done 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
Initialize the Classes

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

configureSummary

protected void configureSummary()
                         throws java.lang.Exception
Writes the actual contents of the status bar.

Overrides:
configureSummary in class WcmWizardModule
Throws:
java.lang.Exception

configureRMClassificaitonSelectPage

protected void configureRMClassificaitonSelectPage()
                                            throws java.lang.Exception
Setup the RM Classification selection page

Throws:
java.lang.Exception

configureRMPropertiesPage

protected void configureRMPropertiesPage()
                                  throws java.lang.Exception
Setup the Properties page

Throws:
java.lang.Exception

configureAddEntryFolderSelectionPage

protected void configureAddEntryFolderSelectionPage()
                                             throws java.lang.Exception
Setup the Add Entry folder selection page

Throws:
java.lang.Exception

configureAddEntryPropertiesSelectionPage

protected void configureAddEntryPropertiesSelectionPage()
                                                 throws java.lang.Exception
Setup the Add Entry properties selection page

Throws:
java.lang.Exception

configureAddEntrySecuritySelectionPage

protected void configureAddEntrySecuritySelectionPage()
                                               throws java.lang.Exception
Setup the Add Entry security selection page

Throws:
java.lang.Exception

getRMClassificationWizardPage

public RMClassificationWizardPage getRMClassificationWizardPage()
Get accessor returns RMClassificationWizardPage

Returns:
WcmEntryDesignerFolderWizardPage

getRMPropertiesWizardPage

public RMPropertiesWizardPage getRMPropertiesWizardPage()
Get accessor returns RMPropertiesWizardPage

Returns:
WcmEntryDesignerClassWizardPage

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 - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

saveModuleProperties

protected boolean saveModuleProperties(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response,
                                       int panelNumber,
                                       boolean skip)
                                throws java.lang.Exception
Save module properties if user did not select those page then we have force to save its content back to entry template

Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
panelNumber - Module panel number
Throws:
java.lang.Exception

onFinish

public void onFinish(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
When Finish button is pressed, add the folder as requested. Then cancels all pages, resets the PageId to null, and redirects.

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

addPanelSelectionAnchor

protected void addPanelSelectionAnchor(int panelNumber)
                                throws java.lang.Exception
Overrides:
addPanelSelectionAnchor in class WcmWizardModule
Throws:
java.lang.Exception

setIsFinished

protected void setIsFinished()
                      throws java.lang.Exception
Goes through the pages and sets the isFinished member of WcmPage

Overrides:
setIsFinished in class WcmWizardModule
Throws:
java.lang.Exception

setMode

public void setMode(java.lang.String mode)
Indicate what mode this module is working at

Parameters:
mode - String Add or Modify.

cleanup

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

Throws:
java.lang.Exception

initialStateData

protected void initialStateData()
                         throws java.lang.Exception
Initialize state data

Throws:
java.lang.Exception


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