com.filenet.wcm.apps.server.ui.info.processors
Class LaunchApprovalInfo

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

public class LaunchApprovalInfo
extends ProcessorModule

The HTML Approval Launch Processor. Made specifically for the Object approval workflows created by the Entry Template designer. However, this is a general step processor and can be used by any workflow.


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  java.lang.String attachmentId
           
protected  com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider edp
           
protected  EProcessMultilingualUtil eProcessMultilingualUtil
           
protected  com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil
           
protected  java.lang.String propertyMap
           
protected  com.filenet.wcm.toolkit.server.util.WcmStepElementState stepElementState
           
protected  java.lang.String subject
           
protected  TaskInfoPage taskInfoPage
           
protected  java.lang.String workflowVersion
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.info.processors.ProcessorModule
actionButtons, addContextMenu, bannerModule, collapseInstructions, contextMenu, displayDefaultButtons, footerLinksBarModule, footerModule, instructionsModule, instructionsText, layout, pathModule, renderBannerModule, renderFooterLinksBarModule, renderFooterModule, renderTopTabBarModule, renderTreeView, summaryModule, titleBarModule, topTabBarModule, treeModule, viewsNode, wsClickApply, wsObjectTypeLabel
 
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
controller, currentModule, currentPanel, currentPanelNumber, panelList
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
LaunchApprovalInfo()
           
 
Method Summary
 void cleanup(boolean clearQueueData)
          Cleans up.
protected  void configureSummary(org.w3c.dom.Element stepElement)
          Writes the actual contents of the status bar.
 TaskInfoPage getTaskInfoPage()
          Accessor method to return the TaskInfoPage object.
 void initialize()
          Initializes the class data.
 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)
          Exit out of the Launch processor without launching the workflow
 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.info.processors.ProcessorModule
addActionButton, addActionButton, addActionButtons, addApplyButton, addDefaultButtons, addPanelSelectionAnchor, addSummaryItem, addTabBar, configureTreeView, getDefaultInstructionsMode, getPathView, getSummaryModule, getTextLinksBar, onCollapse, onExpand, setAddContextMenu, setCurrentPanelSelection, setDefaultInstructionsMode, setDisplayDefaultButtons, setExitLinkText, setInstructionsText, setInstructionsText, setMultiPanelModuleTitle, 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, 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

edp

protected com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider edp

eProcessMultilingualUtil

protected EProcessMultilingualUtil eProcessMultilingualUtil

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

stepElementState

protected com.filenet.wcm.toolkit.server.util.WcmStepElementState stepElementState

taskInfoPage

protected TaskInfoPage taskInfoPage

eProcessUtil

protected com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil

workflowVersion

protected java.lang.String workflowVersion

attachmentId

protected java.lang.String attachmentId

subject

protected java.lang.String subject

propertyMap

protected java.lang.String propertyMap
Constructor Detail

LaunchApprovalInfo

public LaunchApprovalInfo()
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 ProcessorModule
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 ProcessorModule
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 ProcessorModule
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.

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Exit out of the Launch processor without launching the workflow

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

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

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.

configureSummary

protected void configureSummary(org.w3c.dom.Element stepElement)
                         throws java.lang.Exception
Writes the actual contents of the status bar.

Parameters:
stepElement - Element object holding step information
Throws:
java.lang.Exception - If there are problems retrieving data.

getTaskInfoPage

public TaskInfoPage getTaskInfoPage()
Accessor method to return the TaskInfoPage object.

Returns:
TaskInfoPage object.


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