com.filenet.wcm.apps.server.ui.info
Class WcmWorkflowInfo

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.WcmMultiPanelViewModule
                          extended bycom.filenet.wcm.apps.server.ui.WcmInfoModule
                              extended bycom.filenet.wcm.apps.server.ui.info.WcmWorkflowInfo
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmWorkflowInfo
extends WcmInfoModule


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmInfoModule
actionButtons, bannerModule, collapseInstructions, config, controller, displayDefaultButtons, footerLinksBarModule, footerModule, HideApplyButton, instructionsModule, instructionsText, isPrimaryTitle, layout, pathModule, renderBannerModule, renderFooterLinksBarModule, renderFooterModule, renderTopTabBarModule, renderTreeView, sitePrefs, sObjectTypeLabel, textLinksBarModule, titleBarModule, topTabBarModule, treeModule, viewsNode, wsClickApply, wsClickSelectProperties
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
modified, MODIFIED_FLAGS_KEY
 
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
WcmWorkflowInfo()
           
 
Method Summary
 void cleanup()
           
 java.lang.String composeReturnUrl(com.filenet.wcm.toolkit.server.base.WcmController controller, java.lang.String returnUrl)
          Create the return url.
 WcmWorkflowInfoPage getWorkflowInfoPage()
          Accessor method to return the WcmWorkflowInfoPage object.
 void initialize()
          Initializes the class data.
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Close page
 void onLaunch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Launches the workflow.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures the Attachments selection page
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmInfoModule
addActionButton, addActionButton, addActionButtons, addApplyButton, addDefaultButtons, addFooterModules, addPanelSelectionAnchor, addSelectPropertiesButton, addTabBar, configRootViewsNode, configureTreeView, getDefaultInstructionsMode, getPathView, onCollapse, onExpand, render, setCurrentPanelSelection, setDefaultInstructionsMode, setDisplayDefaultButtons, setExitLinkText, setHideApplyButton, setInstructionsText, setInstructionsText, setMultiPanelModuleTitle, setMultiPanelModuleTitle, setPath, setPath, setPath, setRenderBannerModule, setRenderFooterLinksBarModule, setRenderFooterModule, setRenderTopTabBarModule, setRenderTreeView, setRootNodeLabel, setTopTabBarLinks
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
getCurrentViewPanel, isPanelModified, onApply, selectPanel, setPanelModified
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
addPanel, addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, onSelectPanel, 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

WcmWorkflowInfo

public WcmWorkflowInfo()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmInfoModule
Throws:
java.lang.Exception - If there are problems.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Configures the Attachments selection page

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

onLaunch

public void onLaunch(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Launches the workflow.

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

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Close page

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

getWorkflowInfoPage

public WcmWorkflowInfoPage getWorkflowInfoPage()
Accessor method to return the WcmWorkflowInfoPage object.

Returns:
WcmWorkflowInfoPage object.

cleanup

public void cleanup()
             throws java.lang.Exception
Throws:
java.lang.Exception

composeReturnUrl

public java.lang.String composeReturnUrl(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                         java.lang.String returnUrl)
                                  throws java.lang.Exception
Create the return url. This url is typically used to re-enter the object information page with a StateChanged event.

Parameters:
controller - WcmController object.
returnUrl - String current return url.
Returns:
String Return url which includes the rquired event parameters.
Throws:
java.lang.Exception


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