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

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

public class WcmPublishSelectionWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface

This is the first page of Publish wizard, which publishes or republishes a document. In this page, a user selects a publishing template to publish a new document, or the user selects a published document to republish it with the original publishing template.


Field Summary
static com.filenet.wcm.toolkit.util.WcmString wsPublishNew
          PublishNew option type
static com.filenet.wcm.toolkit.util.WcmString wsRepublish
          Republish option type
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmPublishSelectionWizardPage()
          WcmPublishSelectionWizardPage constructor.
 
Method Summary
 WcmItemsListView getItemsListView()
          Get accessor returns WcmItemsListView
 WcmPublishOptionsNavigation getPublishOptionsNavigation()
          Get accessor returns WcmPublishOptionsNavigation
 void initialize()
          Initializes module variables.
 boolean isFinished()
          Returns true to indicate the user has made selection and we can move to next page
 boolean isModal()
          The UI module should return true, if it does not want the wizard to provide page switching functionality.
 void onChoose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Retrieves selected object information from request and sets it into state object.
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Switches mode based on SELECT_MODE value and resets selected object.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Uses preferences to display properties in a list view.
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module that the user does not want to commit the current state to the underlying data store.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Not applicable since this module won't be the last page
 void panelInit()
          Signals to the UI module that its wizard-specific behavior should be initialized (if any).
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Not applicable
protected  java.lang.String[] prepareMagazineProperties()
          Examine Magazine view properties has documentTitile in there if not then add to it.
 void render(java.io.Writer w)
          Renders its contents.
 
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
 

Field Detail

wsRepublish

public static final com.filenet.wcm.toolkit.util.WcmString wsRepublish
Republish option type


wsPublishNew

public static final com.filenet.wcm.toolkit.util.WcmString wsPublishNew
PublishNew option type

Constructor Detail

WcmPublishSelectionWizardPage

public WcmPublishSelectionWizardPage()
                              throws java.lang.Exception
WcmPublishSelectionWizardPage constructor. Initializes member variables.

Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes module variables. Called by Controller during page initialization.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Uses preferences to display properties in a list view.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders its contents.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Output object
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Switches mode based on SELECT_MODE value and resets selected object.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onChoose

public void onChoose(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Retrieves selected object information from request and sets it into state object.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelInit

public void panelInit()
               throws java.lang.Exception
Signals to the UI module that its wizard-specific behavior should be initialized (if any). Retrieves selected object information from state object. This is only done once. If there is no selected object or selected object's mime type is external, an exception will be thrown.

Specified by:
panelInit in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Signals the UI module that the user does not want to commit the current state to the underlying data store.

Specified by:
panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Not applicable since this module won't be the last page

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Not applicable

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

isModal

public boolean isModal()
The UI module should return true, if it does not want the wizard to provide page switching functionality.


isFinished

public boolean isFinished()
                   throws java.lang.Exception
Returns true to indicate the user has made selection and we can move to next page

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

getPublishOptionsNavigation

public WcmPublishOptionsNavigation getPublishOptionsNavigation()
                                                        throws java.lang.Exception
Get accessor returns WcmPublishOptionsNavigation

Returns:
WcmPublishOptionsNavigation
Throws:
java.lang.Exception

getItemsListView

public WcmItemsListView getItemsListView()
                                  throws java.lang.Exception
Get accessor returns WcmItemsListView

Returns:
WcmItemsListView
Throws:
java.lang.Exception

prepareMagazineProperties

protected java.lang.String[] prepareMagazineProperties()
                                                throws java.lang.Exception
Examine Magazine view properties has documentTitile in there if not then add to it.

Returns:
Magazine view properties
Throws:
java.lang.Exception


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