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

Class WcmEntryWizard

  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.toolkit.server.ui.WcmMultiPanelModule
  7. extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
  8. extended bycom.filenet.wcm.apps.server.ui.WcmWizardModule
  9. 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
  1. public class WcmEntryWizard
  2. 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/interfaces inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
WcmWizardModule.WcmWizardPanel

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
 AUTH_STATE_KEY
  1. static
  2. 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

Constructor and Description
WcmEntryWizard()
Constructor

Method Summary

Modifier and Type Method and Description
  1. protected
  2. boolean
 canUserExecuteDeclare(boolean skipAccessCheck)
  1. protected
  2. void
 cleanData(int level)
  1. void
 completeWizard(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
  1. protected
  2. void
 configureSummary()
Adds the appropriate status information to the summary module
  1. protected static
  2. boolean
 containsAny(java.util.Set container,java.util.Collection containees)
  1. protected
  2. java.lang.String
 getAnchor(java.lang.String eventName,java.lang.String sFormName,int nId)
returns the javascript version of the submitForm tag
  1. protected
  2. org.w3c.dom.Document
 getDocumentTitlePattern(org.w3c.dom.Document destXMLProperties)
  1. com.filenet.wcm.toolkit.server.util.WcmEntryTemplate
 getEntryTemplate()
  1. WcmEntryFileSelectWizardPage
 getFileSelectWizardPage()
Get accessor returns WcmEntryFileSelectWizardPage
  1. WcmEntryFolderSelectionWizardPage
 getFolderSelectionWizardPage()
Get accessor returns WcmEntryFolderSelectionWizardPage
  1. WcmEntryPropertiesWizardPage
 getPropertiesWizardPage()
Get accessor returns WcmEntryPropertiesWizardPage
  1. WcmEntrySecurityWizardPage
 getSecurityWizardPage()
Get accessor returns WcmEntrySecurityWizardPage
  1. boolean
 getShowFolderSelectPage()
  1. boolean
 getShowSecurityPage()
  1. boolean
 getShowSetPropertiesPage()
  1. void
 initialize()
This method queries for the Authoring and Navigation data providers, then adds each page to the wizard.
  1. void
 onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
Handle Banner Close event
  1. void
 onCancel(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Called in response to a cancel wizard request.
  1. void
 onComplete(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Helper method called in onFinish event handler.
  1. void
 onFinish(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Called in response to a finish wizard request.
  1. void
 onLocalCopyDeleted(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
  1. void
 onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Configures the pages required for the Wizard
  1. 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.
  1. protected
  2. void
 setIsFinished()
  1. protected
  2. void
 startupRecordTemplate(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Configures Record Template information for startup.
  1. protected
  2. 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

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

Constructor Detail

WcmEntryWizard

  1. public WcmEntryWizard()
  2. throws java.lang.Exception
Constructor
Throws:
java.lang.Exception - If there were problems constructing.

Method Detail

initialize

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

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

  1. public void render(java.io.Writer w)
  2. 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
Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

startupRecordTemplate

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

  1. protected void configureSummary( )
  2. 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

  1. public void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
  2. throws java.lang.Exception
Handle Banner Close event
Parameters:
e - GlobalEvent
Throws:
java.lang.Exception

onCancel

  1. public void onCancel(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Called in response to a cancel wizard request. It releases module properties and calls the base class method.
Overrides:
onCancel in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

onFinish

  1. public void onFinish(javax.servlet.http.HttpServletRequest request,
  2. javax.servlet.http.HttpServletResponse response)
  3. throws java.lang.Exception
Called in response to a finish wizard request. It releases module properties and calls the base class method.
Overrides:
onFinish in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

onComplete

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

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

completeWizard

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

containsAny

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

canUserExecuteDeclare

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

updatePropDescs

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

  1. public WcmEntryFolderSelectionWizardPage getFolderSelectionWizardPage( )
Get accessor returns WcmEntryFolderSelectionWizardPage
Returns:
WcmEntryFolderSelectionWizardPage

getPropertiesWizardPage

  1. public WcmEntryPropertiesWizardPage getPropertiesWizardPage( )
Get accessor returns WcmEntryPropertiesWizardPage
Returns:
WcmEntryPropertiesWizardPage

getSecurityWizardPage

  1. public WcmEntrySecurityWizardPage getSecurityWizardPage( )
Get accessor returns WcmEntrySecurityWizardPage
Returns:
WcmEntrySecurityWizardPage

getFileSelectWizardPage

  1. public WcmEntryFileSelectWizardPage getFileSelectWizardPage( )
Get accessor returns WcmEntryFileSelectWizardPage
Returns:
WcmEntryFileSelectWizardPage

getShowFolderSelectPage

  1. public boolean getShowFolderSelectPage( )

getShowSetPropertiesPage

  1. public boolean getShowSetPropertiesPage( )

getShowSecurityPage

  1. public boolean getShowSecurityPage( )

setIsFinished

  1. protected void setIsFinished()
  2. 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

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

getEntryTemplate

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

getDocumentTitlePattern

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

getAnchor

  1. protected java.lang.String getAnchor( java.lang.String eventName,
  2. java.lang.String sFormName,
  3. int nId)
  4. 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