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

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

public class WcmCheckinWizard
extends WcmWizardModule

Wizard for checking in a document. This wizard adds 3 or 4 pages to complete the check-in task. When run from the document info page, it requires only 3 pages since the first page is used to select the document that the user wants to check in. The other pages allow editing the properties and security, and selecting the edited content to check in.


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.apps.server.ui.WcmWizardModule
WcmWizardModule.WcmWizardPanel
 
Field Summary
 
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
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
WcmCheckinWizard()
          Constructor creates the pages.
 
Method Summary
protected  boolean canDeclare(boolean canDeclare, java.lang.String docClass, com.filenet.wcm.apps.server.presentation.util.ActionConfiguration ac, AccessRoles accessRoles)
           
 void cleanup()
          Clean it up
 void completeWizard(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
protected  void configureSummary()
          Writes the actual contents of the status bar.
protected  java.lang.String getAnchor(java.lang.String eventName, java.lang.String sFormName, int nId)
          returns the javascript version of the submitForm tag
 WcmFileSelectWizardPage getFileSelectWizardPage()
          Get accessor returns WcmFileSelectWizardPage
 WcmPropertiesWizardPage getPropertiesWizardPage()
          Get accessor returns WcmPropertiesWizardPage
 WcmSecurityWizardPage getSecurityWizardPage()
          Get accessor returns WcmSecurityWizardPage
 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 onComplete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the onExit event.
 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)
          Handles the onStartPage event and initilizes the WcmClassWizardPage accordingly if the classid was already specified.
protected  void setIsFinished()
          Goes through the pages and sets the isFinished member of WcmPage
 
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, 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, 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
 

Constructor Detail

WcmCheckinWizard

public WcmCheckinWizard()
                 throws java.lang.Exception
Constructor creates the pages.

Throws:
java.lang.Exception - if there whre rerrors constructing modules
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 there were errors

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles the onStartPage event and initilizes the WcmClassWizardPage accordingly if the classid was already specified.

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.

configureSummary

protected void configureSummary()
                         throws java.lang.Exception
Description copied from class: WcmWizardModule
Writes the actual contents of the status bar. Intended to be overwritten in derived wizard classes

Overrides:
configureSummary in class WcmWizardModule
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 - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - if there were errors

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 - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - if there were errors

onExit

public void onExit(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Handles the onExit event. When extending this method, call super.onExit() in the end.

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

canDeclare

protected boolean canDeclare(boolean canDeclare,
                             java.lang.String docClass,
                             com.filenet.wcm.apps.server.presentation.util.ActionConfiguration ac,
                             AccessRoles accessRoles)

onComplete

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

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

getPropertiesWizardPage

public WcmPropertiesWizardPage getPropertiesWizardPage()
Get accessor returns WcmPropertiesWizardPage

Returns:
WcmPropertiesWizardPage

getSecurityWizardPage

public WcmSecurityWizardPage getSecurityWizardPage()
Get accessor returns WcmSecurityWizardPage

Returns:
WcmSecurityWizardPage

getFileSelectWizardPage

public WcmFileSelectWizardPage getFileSelectWizardPage()
Get accessor returns WcmFileSelectWizardPage

Returns:
WcmFileSelectWizardPage

cleanup

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

Throws:
java.lang.Exception

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

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.