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

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

public class StepApprovalInfo
extends ProcessorModule

The HTML Approval Step 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  com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider edp
           
protected  EProcessMultilingualUtil eProcessMultilingualUtil
           
protected  com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil
           
protected  WcmStepHistoryInfoPage historyInfoPage
           
protected  WcmMilestoneInfoPage milestoneInfoPage
           
protected  java.lang.String queueName
           
protected  com.filenet.wcm.toolkit.server.util.WcmStepElementState stepElementState
           
protected  TaskInfoPage taskInfoPage
           
protected  java.lang.String wobNum
           
 
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
StepApprovalInfo()
           
 
Method Summary
protected  void addCommands(org.w3c.dom.Element stepElement)
          Helper method to add the commands the the command bar.
 void cleanup(boolean clearQueueData)
          Cleans up.
protected  void configureSummary(org.w3c.dom.Element stepElement)
          Writes the actual contents of the status bar.
 WcmMilestoneInfoPage getMilestoneInfoPage()
          Accessor method to return the WcmMilestoneInfoPage object.
 WcmStepHistoryInfoPage getStepHistoryInfoPage()
          Accessor method to return the WcmStepHistoryInfoPage object.
 TaskInfoPage getTaskInfoPage()
          Accessor method to return the TaskInfoPage object.
 void initialize()
          Initializes the class data.
 void onApply(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves the work item associated with this step element.
 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)
          Unlocks a work item associated with this step without updating the fields on the work item.
 void onComplete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Completes this step by moving to the next workflow step.
 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 onMoveToInbox(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          MoveS the work item to the current user inbox.
 void onReassign(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Changes the participant responsible for processing the current step.
 void onReassigned(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Reassigned event triggered by the user reassigned the step.
 void onReturnToSender(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns the work item to the queue from which a user originally reassigned or delegated the work item.
 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, 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
 

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

milestoneInfoPage

protected WcmMilestoneInfoPage milestoneInfoPage

historyInfoPage

protected WcmStepHistoryInfoPage historyInfoPage

eProcessUtil

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

queueName

protected java.lang.String queueName

wobNum

protected java.lang.String wobNum
Constructor Detail

StepApprovalInfo

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

onComplete

public void onComplete(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Completes this step by moving to the next workflow step. Saves changes made in the workflow at this step.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onApply

public void onApply(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Saves the work item associated with this step element.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onMoveToInbox

public void onMoveToInbox(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
MoveS the work item to the current user inbox.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onReassign

public void onReassign(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Changes the participant responsible for processing the current step.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onReturnToSender

public void onReturnToSender(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
Returns the work item to the queue from which a user originally reassigned or delegated the work item.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

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

onClose

public void onClose(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

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

onReassigned

public void onReassigned(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Handles the Reassigned event triggered by the user reassigned the step.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
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.

addCommands

protected void addCommands(org.w3c.dom.Element stepElement)
                    throws java.lang.Exception
Helper method to add the commands the the command bar.

Parameters:
stepElement - Element object holding the step element xml.
Throws:
java.lang.Exception - if there were errors retrieving data.

getTaskInfoPage

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

Returns:
TaskInfoPage object.

getStepHistoryInfoPage

public WcmStepHistoryInfoPage getStepHistoryInfoPage()
Accessor method to return the WcmStepHistoryInfoPage object.

Returns:
WcmStepHistoryInfoPage object.

getMilestoneInfoPage

public WcmMilestoneInfoPage getMilestoneInfoPage()
Accessor method to return the WcmMilestoneInfoPage object.

Returns:
WcmMilestoneInfoPage object.


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