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

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

public class WcmWorkflowInfoPage
extends TaskInfoPage


Field Summary
protected  StepParticipantModule stepParticipant
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.info.processors.TaskInfoPage
adp, edp, eProcessMultilingualUtil, eProcessUtil, formName, processorType, stepElementState, taskAttachments, taskFooter, taskHeader, taskParameter, xmlDoc
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmWorkflowInfoPage(int processorType)
          Constructor
 
Method Summary
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes the class data and the XSL parameters for the associated XSL file.
 boolean isApplyButtonRequired()
          Implement, and return "true" if you want the WcmInfo container to show an "Apply" button.
 boolean isModified()
          Return true if the state has changed as a result of a wizardSave call.
 void onSelectStep(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary workflow step configuration page.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Start Page event triggered by the controller.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module to commit its state to the data provider.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals to the UI module to persist the incoming form data to its current state.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void render(java.io.Writer w)
          Renders the class data.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.info.processors.TaskInfoPage
addAttachment, addReferenceAttachment, buildSelectFileURL, buildSelectObjectURL, cleanup, getExecuteKey, getFormName, isAttachmentsModified, onAddFormTemplate, onAddTemplate, onAssign, onAssignReference, onGetInfo, onGroupModified, onRemove, onReplaceFormTemplate, onReplaceTemplate, onSelectAttachment, onSelectField, onSelectFile, onSelectGroup, onSelectObject, onSubmit, onUnassign, removeAttachment, setIsAttachmentModified, setIsModified, setLocale, setPageInfo
 
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
 

Field Detail

stepParticipant

protected StepParticipantModule stepParticipant
Constructor Detail

WcmWorkflowInfoPage

public WcmWorkflowInfoPage(int processorType)
                    throws java.lang.Exception
Constructor

Parameters:
processorType - int processor type (step processor or launch step processor)
Throws:
java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data and the XSL parameters for the associated XSL file.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class TaskInfoPage
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
Handles the Start Page event triggered by the controller.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class TaskInfoPage
Parameters:
request - The Java™Server Pages (JSP) request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

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 TaskInfoPage
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

onSelectStep

public void onSelectStep(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Used by links to redirect to secondary workflow step configuration page.

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

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Signals to the UI module to persist the incoming form data to its current state.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Overrides:
panelSave in class TaskInfoPage
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Overrides:
panelValidate in class TaskInfoPage
Returns:
boolean whether page validated correctly or not.
Throws:
java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Signals the UI module to commit its state to the data provider.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Overrides:
panelFinish in class TaskInfoPage
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

isModified

public boolean isModified()
                   throws java.lang.Exception
Return true if the state has changed as a result of a wizardSave call.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Overrides:
isModified in class TaskInfoPage
Returns:
If you're not using this feature, return false.
Throws:
java.lang.Exception - If there are problems.

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Implement, and return "true" if you want the WcmInfo container to show an "Apply" button. When Apply is pressed by the user, the UI module will get a call to wizardFinish.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Overrides:
isApplyButtonRequired in class TaskInfoPage
Returns:
True Apply button required
Throws:
java.lang.Exception - If there are problems.

getValidationErrors

public java.util.Iterator getValidationErrors()
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Overrides:
getValidationErrors in class TaskInfoPage


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