com.filenet.wcm.apps.server.ui
Class WcmWorkflowModule

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

public class WcmWorkflowModule
extends com.filenet.wcm.toolkit.server.ui.WcmJSPModule

UI module use to present the Workflow creation form. Allows the user the ability to configure the workflow.


Field Summary
static java.lang.String MODE_DESIGN
           
static java.lang.String MODE_LAUNCH
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmWorkflowModule()
           
 
Method Summary
 java.lang.String getDisplayMode()
          Returns the display mode
 java.lang.String getFormName()
          Returns the form name used by WcmWorkflowModule.
 void initialize()
          Initialize this UI module.
 void onAddNew(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler that adds a new step to the workflow
 void onContinue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Save the changes
 void onSelectAttachment(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary workflow attachment configuration page.
 void onSelectField(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary workflow data field configuration page.
 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)
          Event handler for controllers onStartPage event.
 void onUpdate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler that updates the list of steps.
 void setDisplayMode(java.lang.String mode)
          Sets the display mode
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
getCurrentModule, render
 
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

MODE_DESIGN

public static final java.lang.String MODE_DESIGN
See Also:
Constant Field Values

MODE_LAUNCH

public static final java.lang.String MODE_LAUNCH
See Also:
Constant Field Values
Constructor Detail

WcmWorkflowModule

public WcmWorkflowModule()
Method Detail

initialize

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

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.

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

onSelectField

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

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

onSelectAttachment

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

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

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

onAddNew

public void onAddNew(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event handler that adds a new step to the workflow

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onUpdate

public void onUpdate(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event handler that updates the list of steps. Any steps selected for removal will be deleted.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onContinue

public void onContinue(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Save the changes

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

getFormName

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

Returns:
The form name, returns null if no form is used.

getDisplayMode

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

Returns:
mode display mode

setDisplayMode

public void setDisplayMode(java.lang.String mode)
                    throws java.lang.Exception
Sets the display mode

Parameters:
mode - display mode
Throws:
java.lang.Exception


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