com.filenet.wcm.apps.server.ui.wizard
Class WcmWorkflowDefinitionSelectionWizardPage

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.wizard.WcmWorkflowDefinitionSelectionWizardPage
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.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmWorkflowDefinitionSelectionWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

This wizard page module displays Workflow Definitions to allow the user to select a workflow definition for a worflow subscription.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmWorkflowDefinitionSelectionWizardPage(int page)
          Constructor sets the operation type to one of the static int values defined above.
 
Method Summary
 WcmItemsListView getItemsListView()
          Accessor method to return the WcmItemsListView object.
 com.filenet.wcm.apps.server.presentation.ui.PathView getPathView()
          Accessor method to return the PathView object.
 java.util.Iterator getValidationErrors()
           
 WcmWorkflowDefinitionsListView getWorkflowDefinitionsListView()
          Accessor method to return the WcmWorkflowDefinitionsListView object.
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 boolean isFinished()
          Indicates if the input is complete.
 void onSelectDefinition(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectRoot(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectVersion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectVersionNumber(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event sets up the display objects for rendering.
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears state information.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Normally not called directly since this page should never show the Finish button.
 void panelInit()
          Called when this wizard page is first loaded to clear out any residual state information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called to save the state of the page.
 boolean panelValidate()
           
 void render(java.io.Writer w)
          Renders the folder navigation hierarchy.
 void setWorkflowDefinition(java.lang.String id, java.lang.String label)
           
 
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, getFormName, 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

WcmWorkflowDefinitionSelectionWizardPage

public WcmWorkflowDefinitionSelectionWizardPage(int page)
                                         throws java.lang.Exception
Constructor sets the operation type to one of the static int values defined above.

Parameters:
page - One of the defined int field types.
Method Detail

getPathView

public com.filenet.wcm.apps.server.presentation.ui.PathView getPathView()
Accessor method to return the PathView object.

Returns:
PathView object.

getWorkflowDefinitionsListView

public WcmWorkflowDefinitionsListView getWorkflowDefinitionsListView()
Accessor method to return the WcmWorkflowDefinitionsListView object.

Returns:
WcmWorkflowDefinitionsListView object.

getItemsListView

public WcmItemsListView getItemsListView()
Accessor method to return the WcmItemsListView object.

Returns:
WcmItemsListView object.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the folder navigation hierarchy.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write to.
Throws:
java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception
Initializes data providers, XSL parameters, the authoring state, and other state values.

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

onSelectRoot

public void onSelectRoot(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Throws:
java.lang.Exception

setWorkflowDefinition

public void setWorkflowDefinition(java.lang.String id,
                                  java.lang.String label)
                           throws java.lang.Exception
Throws:
java.lang.Exception

onSelectDefinition

public void onSelectDefinition(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
Throws:
java.lang.Exception

onSelectVersion

public void onSelectVersion(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Throws:
java.lang.Exception

onSelectVersionNumber

public void onSelectVersionNumber(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws java.lang.Exception
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
The default event sets up the display objects for rendering.

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

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Throws:
java.lang.Exception

getValidationErrors

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

panelInit

public void panelInit()
               throws java.lang.Exception
Called when this wizard page is first loaded to clear out any residual state information.

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

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Clears state information.

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

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Called to save the state of the page. It calls wizardFinish to set the Authoring state using the chosen folder.

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

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Normally not called directly since this page should never show the Finish button. The wizardSave method forwards save requests here where it sets the Authoring state using the chosen folder.

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

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Indicates if the input is complete. If a folder is selected, returns true. If an object store is selected and a folder is being added, returns true. Returns false otherwise.

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Returns:
boolean indicating if the input is complete.
Throws:
java.lang.Exception


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