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

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

public class WcmLaunchProcessorInfo
extends WcmInfoModule

The HTML Launch Step Processor.


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
NAME_DELIMITER
 
Constructor Summary
WcmLaunchProcessorInfo()
           
 
Method Summary
 void cleanup(boolean clearQueueData)
          Cleans up.
 WcmAttachmentInfoPage getAttachmentInfoPage()
          Accessor method to return the WcmAttachmentInfoPage object.
 com.filenet.wcm.toolkit.server.util.WcmEProcessUtil getEProcessUtil()
          Accessor method to return the WcmEProcessUtil object.
 WcmFieldInfoPage getFieldInfoPage()
          Accessor method to return the WcmFieldInfoPage object.
 WcmGeneralStepInfoPage getGeneralStepInfoPage()
          Accessor method to return the WcmGeneralStepInfoPage object.
 WcmGroupInfoPage getGroupInfoPage()
          Accessor method to return the WcmGroupInfoPage object.
 void initialize()
          Initializes the class data.
 void onApply(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs the user clicks Apply button.
 void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
          Handle Banner Close event
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Closes the popup window and return to destination url (if specified)
 void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Unlocks a work item associated with this step without updating the fields on the work item.
 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 path information and adds the appropriate commands to the toolbar.
 void render(java.io.Writer w)
          Renders the class data.
 
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, 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, selectPanel, setPanelModified
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
addPanel, addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, 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, 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

WcmLaunchProcessorInfo

public WcmLaunchProcessorInfo()
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 path information and adds the appropriate commands to the toolbar.

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.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class WcmInfoModule
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

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.

onExit

public void onExit(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Unlocks a work item associated with this step without updating the fields on the work item.

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
Closes the popup window and return to destination url (if specified)

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - if something goes wrong

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 - if something goes wrong

onApply

public void onApply(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Event that occurs the user clicks Apply button.

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

cleanup

public void cleanup(boolean clearQueueData)
             throws java.lang.Exception
Cleans up.

Parameters:
clearQueueData - boolean flag to specify whether the queue list information should be cleared
Throws:
java.lang.Exception - If there are problems.

getGeneralStepInfoPage

public WcmGeneralStepInfoPage getGeneralStepInfoPage()
Accessor method to return the WcmGeneralStepInfoPage object.

Returns:
WcmGeneralStepInfoPage object.

getAttachmentInfoPage

public WcmAttachmentInfoPage getAttachmentInfoPage()
Accessor method to return the WcmAttachmentInfoPage object.

Returns:
WcmAttachmentInfoPage object.

getFieldInfoPage

public WcmFieldInfoPage getFieldInfoPage()
Accessor method to return the WcmFieldInfoPage object.

Returns:
WcmFieldInfoPage object.

getGroupInfoPage

public WcmGroupInfoPage getGroupInfoPage()
Accessor method to return the WcmGroupInfoPage object.

Returns:
WcmGroupInfoPage object.

getEProcessUtil

public com.filenet.wcm.toolkit.server.util.WcmEProcessUtil getEProcessUtil()
Accessor method to return the WcmEProcessUtil object.

Returns:
WcmEProcessUtil object.


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