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

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

public class WcmEntryWizard
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
static java.lang.String AUTH_STATE_KEY
           
static java.lang.String NAVI_STATE_KEY
           
 
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
WcmEntryWizard()
          Constructor
 
Method Summary
protected  boolean canUserExecuteDeclare(boolean skipAccessCheck)
           
protected  void cleanData(int level)
           
 void completeWizard(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
protected  void configureSummary()
          Adds the appropriate status information to the summary module
protected static boolean containsAny(java.util.Set container, java.util.Collection containees)
           
protected  java.lang.String getAnchor(java.lang.String eventName, java.lang.String sFormName, int nId)
          returns the javascript version of the submitForm tag
protected  org.w3c.dom.Document getDocumentTitlePattern(org.w3c.dom.Document destXMLProperties)
           
 com.filenet.wcm.toolkit.server.util.WcmEntryTemplate getEntryTemplate()
           
 WcmEntryFileSelectWizardPage getFileSelectWizardPage()
          Get accessor returns WcmEntryFileSelectWizardPage
 WcmEntryFolderSelectionWizardPage getFolderSelectionWizardPage()
          Get accessor returns WcmEntryFolderSelectionWizardPage
 WcmEntryPropertiesWizardPage getPropertiesWizardPage()
          Get accessor returns WcmEntryPropertiesWizardPage
 WcmEntrySecurityWizardPage getSecurityWizardPage()
          Get accessor returns WcmEntrySecurityWizardPage
 boolean getShowFolderSelectPage()
           
 boolean getShowSecurityPage()
           
 boolean getShowSetPropertiesPage()
           
 void initialize()
          This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
 void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
          Handle Banner Close event
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called in response to a cancel wizard request.
 void onComplete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Helper method called in onFinish event handler.
 void onFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called in response to a finish wizard request.
 void onLocalCopyDeleted(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures the pages required for the Wizard
 void render(java.io.Writer w)
          If there is no pages to display (all wizard pages are set to hide), don't call super.render.
protected  void setIsFinished()
          Goes through the pages and sets the isFinished member of WcmPage
protected  void startupRecordTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures Record Template information for startup.
protected  void updatePropDescs(javax.servlet.http.HttpServletRequest request)
          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, getFooter, getPageBanner, getSummaryModule, getTabBar, getTextLinksBar, isBackEnabled, isFinishEnabled, isNextEnabled, isPanelEnabled, okayToProceed, onSelectPanel, 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, 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.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

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
Constructor Detail

WcmEntryWizard

public WcmEntryWizard()
               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
Configures the pages required for the Wizard

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class WcmWizardModule
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.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
If there is no pages to display (all wizard pages are set to hide), don't call super.render. This is for WebSphere, WebLogic don't have same problem. - ldp 9/21/06

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class WcmWizardModule
Throws:
java.lang.Exception

startupRecordTemplate

protected void startupRecordTemplate(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws java.lang.Exception
Configures Record Template information for startup.

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

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.

onBannerClose

public void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                   throws java.lang.Exception
Handle Banner Close event

Parameters:
e - GlobalEvent
Throws:
java.lang.Exception

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 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
Called in response to a finish wizard request. It releases module properties and calls the base class method.

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

onComplete

public void onComplete(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Helper method called in onFinish event handler. Configures 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.

onLocalCopyDeleted

public void onLocalCopyDeleted(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
Throws:
java.lang.Exception

completeWizard

public void completeWizard(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Throws:
java.lang.Exception

containsAny

protected static boolean containsAny(java.util.Set container,
                                     java.util.Collection containees)

canUserExecuteDeclare

protected boolean canUserExecuteDeclare(boolean skipAccessCheck)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

updatePropDescs

protected void updatePropDescs(javax.servlet.http.HttpServletRequest request)
                        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.

Throws:
java.lang.Exception

getFolderSelectionWizardPage

public WcmEntryFolderSelectionWizardPage getFolderSelectionWizardPage()
Get accessor returns WcmEntryFolderSelectionWizardPage

Returns:
WcmEntryFolderSelectionWizardPage

getPropertiesWizardPage

public WcmEntryPropertiesWizardPage getPropertiesWizardPage()
Get accessor returns WcmEntryPropertiesWizardPage

Returns:
WcmEntryPropertiesWizardPage

getSecurityWizardPage

public WcmEntrySecurityWizardPage getSecurityWizardPage()
Get accessor returns WcmEntrySecurityWizardPage

Returns:
WcmEntrySecurityWizardPage

getFileSelectWizardPage

public WcmEntryFileSelectWizardPage getFileSelectWizardPage()
Get accessor returns WcmEntryFileSelectWizardPage

Returns:
WcmEntryFileSelectWizardPage

getShowFolderSelectPage

public boolean getShowFolderSelectPage()

getShowSetPropertiesPage

public boolean getShowSetPropertiesPage()

getShowSecurityPage

public boolean getShowSecurityPage()

setIsFinished

protected void setIsFinished()
                      throws java.lang.Exception
Description copied from class: WcmWizardModule
Goes through the pages and sets the isFinished member of WcmPage

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

cleanData

protected void cleanData(int level)
                  throws java.lang.Exception
Throws:
java.lang.Exception

getEntryTemplate

public com.filenet.wcm.toolkit.server.util.WcmEntryTemplate getEntryTemplate()

getDocumentTitlePattern

protected org.w3c.dom.Document getDocumentTitlePattern(org.w3c.dom.Document destXMLProperties)
                                                throws java.lang.Exception
Throws:
java.lang.Exception

getAnchor

protected java.lang.String getAnchor(java.lang.String eventName,
                                     java.lang.String sFormName,
                                     int nId)
                              throws java.lang.Exception
returns the javascript version of the submitForm tag

Overrides:
getAnchor in class WcmWizardModule
Parameters:
eventName - The eventName this Anchor should call.
sFormName - The form that should be submitted by this Anchor.
nId - The Page number that this event refers to.
Returns:
The href to use for the specified anchor.
Throws:
java.lang.Exception


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