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

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

public class WcmWorkflowSubscription
extends WcmWizardModule

This wizard is for adding a new workflow subscription. op=StartWizard means initalize for new op=UsePageParams means initalize for modify


Nested Class Summary
 class WcmWorkflowSubscription.SubscriptionState
           
 class WcmWorkflowSubscription.WorkflowDefinitionState
           
 
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
WcmWorkflowSubscription()
          Constructor calls base class constructor, then creates the required pages.
 
Method Summary
 void configureSelectedSubscription(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void configureSelectedWorkflowDefinition(WcmAuthoringState authorState)
           
protected  void configureSummary()
          Writes the actual contents of the status bar.
 WcmExpressionWizardPage getExpressionWizardPage()
          Get accessor returns WcmExpressionWizardPage
 com.filenet.wcm.toolkit.server.base.WcmUiModule getFirstWizardPage()
          Get accessor returns WcmTargetSelectionWizardPage
 WcmPropertyMapWizardPage getPropertyMapWizardPage()
          Get accessor returns WcmPropertyMapWizardPage
 WcmWorkflowSubscription.WorkflowDefinitionState getWorkflowDefinitionState()
           
 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 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 onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event, calling WcmController.setHelpContext for the current page.
 void selectPanel(int currentPanelNbr, int newPanelNbr, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
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, 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
 
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, 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
 

Constructor Detail

WcmWorkflowSubscription

public WcmWorkflowSubscription()
                        throws java.lang.Exception
Constructor calls base class constructor, then creates the required pages.

Throws:
java.lang.Exception - if there were problems constructing module.
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:
com.filenet.wcm.toolkit.util.WcmException - If a data provider was not found.
java.lang.Exception

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

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

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.

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.

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

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.

Throws:
java.lang.Exception

getFirstWizardPage

public com.filenet.wcm.toolkit.server.base.WcmUiModule getFirstWizardPage()
Get accessor returns WcmTargetSelectionWizardPage

Returns:
WcmTargetSelectionWizardPage

getExpressionWizardPage

public WcmExpressionWizardPage getExpressionWizardPage()
Get accessor returns WcmExpressionWizardPage

Returns:
WcmExpressionWizardPage

getPropertyMapWizardPage

public WcmPropertyMapWizardPage getPropertyMapWizardPage()
Get accessor returns WcmPropertyMapWizardPage

Returns:
WcmPropertyMapWizardPage

selectPanel

public void selectPanel(int currentPanelNbr,
                        int newPanelNbr,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Throws:
java.lang.Exception

configureSelectedWorkflowDefinition

public void configureSelectedWorkflowDefinition(WcmAuthoringState authorState)
                                         throws java.lang.Exception
Throws:
java.lang.Exception

configureSelectedSubscription

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

getWorkflowDefinitionState

public WcmWorkflowSubscription.WorkflowDefinitionState getWorkflowDefinitionState()
                                                                           throws java.lang.Exception
Throws:
java.lang.Exception


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