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

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.WcmJSPModule
                      extended bycom.filenet.wcm.apps.server.ui.info.WcmWorkflowStepInfoPage
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 WcmWorkflowStepInfoPage
extends com.filenet.wcm.toolkit.server.ui.WcmJSPModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

Information module that presents the properties for a workflow step.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
WcmWorkflowStepInfoPage()
           
 
Method Summary
 java.lang.String getDisplayMode()
          Returns the display mode
 java.lang.String getFormName()
          Returns the form name used by WcmWorkflowStepInfoPage.
 java.util.ArrayList getParticipants()
          Returns the current parameters
 java.lang.String getStepName()
          Returns the current step name.
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initialize this UI module.
 boolean isApplyButtonRequired()
          Implement, and return "true" if you want the WcmInfo container to show an "Apply" button.
 boolean isModified()
           
 void onSelectAttachments(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Bring up the Attachment Selection page.
 void onSelectFields(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Bring up the Data Field Selection page.
 void onSelectParticipants(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Bring up the Participant Selection page.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for controllers onStartPage event.
 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)
           
 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.toolkit.server.ui.WcmJSPModule
getCurrentModule
 
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

WcmWorkflowStepInfoPage

public WcmWorkflowStepInfoPage()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initialize this UI module.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Event handler for controllers onStartPage event.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - HttpServletRequest
response - HttpServletResponse
Throws:
java.lang.Exception

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

onSelectFields

public void onSelectFields(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Bring up the Data Field Selection page.

Parameters:
request - The Java™Server Pages (JSP) request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onSelectParticipants

public void onSelectParticipants(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws java.lang.Exception
Bring up the Participant Selection page.

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

onSelectAttachments

public void onSelectAttachments(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws java.lang.Exception
Bring up the Attachment Selection page.

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

getFormName

public java.lang.String getFormName()
Returns the form name used by WcmWorkflowStepInfoPage.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Returns:
The form name, returns null if no form is used.

getStepName

public java.lang.String getStepName()
Returns the current step name.

Returns:
The step name.

getParticipants

public java.util.ArrayList getParticipants()
                                    throws java.lang.Exception
Returns the current parameters

Returns:
ArrayList The list.
Throws:
java.lang.Exception - if there were errors retrieving data.

getDisplayMode

public java.lang.String getDisplayMode()
Returns the display mode

Returns:
String display mode

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Throws:
java.lang.Exception

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid. Only use during runtime (launch) display mode.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
boolean True if the page data validated correctly.
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
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
Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception

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 panelFinish.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
boolean True if the Apply button is required for this page.
Throws:
java.lang.Exception - If there were errors.

getValidationErrors

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


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