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

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.SelectObjectModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
ConvertForWebNavigationPage.SelectTemplate, EntryDesignerRecordsWizardPage.SelectTemplate, RMClassificationWizardPage.SelectStartingClassificationFolder, SelectDeclareAsRecordTemplate, WebContentEntryDesignerContentPage.WebContentSelectLayoutModule

public class SelectObjectModule
extends com.filenet.wcm.toolkit.server.base.WcmUiModule


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  WcmAuthoringState authorState
           
protected  java.lang.String className
           
protected  com.filenet.wcm.toolkit.server.base.WcmController controller
           
protected  java.lang.String eventTargetName
           
protected  boolean hideBrowsePage
           
protected  boolean hideMySearchFilterClass
           
protected  boolean hideMySearchPage
           
protected  boolean hideSearchPage
           
protected  boolean hideSelectCurrent
           
protected  boolean hideSelectLinks
           
protected  boolean hideSelectReleased
           
protected  boolean hideVersionSeries
           
protected  boolean includeSubClass
           
protected  java.lang.String infoPageUrl
           
protected  com.filenet.wcm.toolkit.util.WcmURLBuilder infoUrl
           
protected  java.util.Locale locale
           
protected  java.util.ArrayList mimeTypes
           
protected  java.lang.String objectStoreName
           
protected  java.lang.String refreshUrl
           
protected  java.lang.String selectMode
           
protected  java.lang.String selectPageUrl
           
protected  com.filenet.wcm.toolkit.util.WcmURLBuilder selectUrl
           
protected  boolean showClearButton
           
protected  java.lang.String Title
           
protected  com.filenet.wcm.apps.server.presentation.ui.ToolBar toolBar
           
protected  boolean usePopupWindow
           
protected  com.filenet.wcm.toolkit.util.WcmString wsNotSelected
           
protected static com.filenet.wcm.toolkit.util.WcmString wsVersionInfo
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
SelectObjectModule()
          Create a new SelectObjectModule object for displaying the selected object returned from the select operation page.
 
Method Summary
 void appendMimeType(java.lang.String mimeType)
           
 com.filenet.wcm.toolkit.util.WcmString getClearLinkLabel()
           
protected  java.lang.String getIconUrl()
           
protected  java.lang.String getMimeType()
           
 com.filenet.wcm.apps.server.presentation.ui.ToolBar getToolBar()
          Accessor method to return the WcmToolBar object.
 void initialize()
          Initializes the wizard state and registers all pages.
 void onClearObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the ClearObject event.
 void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SelectObject event.
 void onSetObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SetObject event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void render(java.io.Writer w)
          Renders the SelectObjectModule in HTML.
 void setClass(java.lang.String className)
          Sets the selection class name
 void setClearLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
          Sets the Clear link label
 void setEventTargetName(java.lang.String value)
          Set event target name.
 void setHideBrowsePage(boolean hideBrowsePage)
          Sets to true to hide the Browse page.
 void setHideMySearchFilterClass(boolean hideMySearchFilterClass)
          Sets to true to hide the My Search filter select class link
 void setHideMySearchPage(boolean hideMySearchPage)
          Sets to true to hide the My Search page.
 void setHideSearchPage(boolean hideSearchPage)
          Sets to true to hide the Search page.
 void setHideSelectCurrent(boolean hideSelectCurrent)
          Sets to true to hide the Select Current link
 void setHideSelectLinks(boolean hideSelectLinks)
          Sets to true to hide the Select Release and Select Current links.
 void setHideSelectReleased(boolean hideSelectReleased)
          Sets to true to hide the Select Release link
 void setHideVersionSeries(boolean hideVersionSeries)
          Sets to true to hide the Select From Versions link
 void setIncludeSubClass(boolean includeSubClass)
          Sets to true to include subclass in a My Search searching.
 void setInfoUrl(java.lang.String url)
           
 void setLabel(java.lang.String label)
           
 void setLabel(com.filenet.wcm.toolkit.util.WcmString label)
          Sets the Select Module label
 void setMimeType(java.lang.String mimeType)
          Sets the selection mime type
 void setNotSelectedMessage(com.filenet.wcm.toolkit.util.WcmString newMessage)
           
 void setObjectStore(java.lang.String objectStoreName)
          Sets the selection objectstore
 void setRefreshUrl(java.lang.String refreshUrl)
          Sets the refresh url
 void setSelectLinkLabel(java.lang.String label)
           
 void setSelectLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
          Sets the Select link label
 void setSelectMode(java.lang.String mode)
          Sets the selection mode.
 void setSelectPageUrl(java.lang.String url)
          Set the url to the select operation page.
 void setShowClearButton(boolean showClearButton)
          Sets to true to show the Clear Object link
 void setTitle(java.lang.String title)
           
 void setTitle(com.filenet.wcm.toolkit.util.WcmString title)
          Sets the Title displayed on the select object page
 void setUsePopupWindow(boolean usePopupWindow)
          Set how the selection page will be displayed.
 
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

wsVersionInfo

protected static final com.filenet.wcm.toolkit.util.WcmString wsVersionInfo

wsNotSelected

protected com.filenet.wcm.toolkit.util.WcmString wsNotSelected

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

authorState

protected WcmAuthoringState authorState

toolBar

protected com.filenet.wcm.apps.server.presentation.ui.ToolBar toolBar

controller

protected com.filenet.wcm.toolkit.server.base.WcmController controller

selectUrl

protected com.filenet.wcm.toolkit.util.WcmURLBuilder selectUrl

infoUrl

protected com.filenet.wcm.toolkit.util.WcmURLBuilder infoUrl

showClearButton

protected boolean showClearButton

Title

protected java.lang.String Title

eventTargetName

protected java.lang.String eventTargetName

mimeTypes

protected java.util.ArrayList mimeTypes

className

protected java.lang.String className

includeSubClass

protected boolean includeSubClass

hideBrowsePage

protected boolean hideBrowsePage

hideSearchPage

protected boolean hideSearchPage

hideMySearchPage

protected boolean hideMySearchPage

hideSelectCurrent

protected boolean hideSelectCurrent

hideSelectReleased

protected boolean hideSelectReleased

hideVersionSeries

protected boolean hideVersionSeries

hideSelectLinks

protected boolean hideSelectLinks

hideMySearchFilterClass

protected boolean hideMySearchFilterClass

usePopupWindow

protected boolean usePopupWindow

objectStoreName

protected java.lang.String objectStoreName

refreshUrl

protected java.lang.String refreshUrl

selectMode

protected java.lang.String selectMode

selectPageUrl

protected java.lang.String selectPageUrl

infoPageUrl

protected java.lang.String infoPageUrl

locale

protected java.util.Locale locale
Constructor Detail

SelectObjectModule

public SelectObjectModule()
Create a new SelectObjectModule object for displaying the selected object returned from the select operation page.

Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the wizard state and registers all pages.

Throws:
java.lang.Exception

onStartPage

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the SelectObjectModule in HTML.

Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

onSelectObject

public void onSelectObject(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Handles the SelectObject event.

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

onSetObject

public void onSetObject(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles the SetObject event.

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

onClearObject

public void onClearObject(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Handles the ClearObject event.

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

setSelectMode

public void setSelectMode(java.lang.String mode)
Sets the selection mode.

Parameters:
mode - String The select operation selection mode.

setTitle

public void setTitle(com.filenet.wcm.toolkit.util.WcmString title)
Sets the Title displayed on the select object page

Parameters:
title - WcmString The Title to be displayed on the select object page.

setTitle

public void setTitle(java.lang.String title)

setLabel

public void setLabel(com.filenet.wcm.toolkit.util.WcmString label)
Sets the Select Module label

Parameters:
label - WcmString The Select Module label. The default is set to "Selected Object"

setLabel

public void setLabel(java.lang.String label)

setSelectLinkLabel

public void setSelectLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
Sets the Select link label

Parameters:
label - WcmString The Select link label. The default is set to "Select Object"

setSelectLinkLabel

public void setSelectLinkLabel(java.lang.String label)

setClearLinkLabel

public void setClearLinkLabel(com.filenet.wcm.toolkit.util.WcmString label)
Sets the Clear link label

Parameters:
label - WcmString The Clear link label. The default is set to "Clear Object"

getClearLinkLabel

public com.filenet.wcm.toolkit.util.WcmString getClearLinkLabel()

setShowClearButton

public void setShowClearButton(boolean showClearButton)
Sets to true to show the Clear Object link

Parameters:
showClearButton - boolean True to show the Clear Object link.

setMimeType

public void setMimeType(java.lang.String mimeType)
Sets the selection mime type

Parameters:
mimeType - String The selection mime type. Only object of this mime type will be available for selection.

appendMimeType

public void appendMimeType(java.lang.String mimeType)

setClass

public void setClass(java.lang.String className)
Sets the selection class name

Parameters:
className - String The selection class. Only object of this class will be available for selection.

setObjectStore

public void setObjectStore(java.lang.String objectStoreName)
Sets the selection objectstore

Parameters:
objectStoreName - String The selection objectstore. Only object in this objectstore will be available for selection.

setRefreshUrl

public void setRefreshUrl(java.lang.String refreshUrl)
                   throws java.lang.Exception
Sets the refresh url

Parameters:
refreshUrl - String the refresl url
Throws:
java.lang.Exception

setHideSelectLinks

public void setHideSelectLinks(boolean hideSelectLinks)
Sets to true to hide the Select Release and Select Current links.

Parameters:
hideSelectLinks - boolean true to hide the Select Release and Select Current links.

setHideSelectCurrent

public void setHideSelectCurrent(boolean hideSelectCurrent)
Sets to true to hide the Select Current link

Parameters:
hideSelectCurrent - boolean True to hide the Select Current link

setHideSelectReleased

public void setHideSelectReleased(boolean hideSelectReleased)
Sets to true to hide the Select Release link

Parameters:
hideSelectReleased - boolean True to hide the Select Release link

setHideVersionSeries

public void setHideVersionSeries(boolean hideVersionSeries)
Sets to true to hide the Select From Versions link

Parameters:
hideVersionSeries - boolean True to hide the Select From Versions link

setHideBrowsePage

public void setHideBrowsePage(boolean hideBrowsePage)
Sets to true to hide the Browse page.

Parameters:
hideBrowsePage - boolean true to hide the Browse page tab.

setHideSearchPage

public void setHideSearchPage(boolean hideSearchPage)
Sets to true to hide the Search page.

Parameters:
hideSearchPage - boolean true to hide the Search page tab.

setHideMySearchPage

public void setHideMySearchPage(boolean hideMySearchPage)
Sets to true to hide the My Search page.

Parameters:
hideMySearchPage - boolean true to hide the the My Search page tab.

setHideMySearchFilterClass

public void setHideMySearchFilterClass(boolean hideMySearchFilterClass)
Sets to true to hide the My Search filter select class link

Parameters:
hideMySearchFilterClass - boolean true to hide the My Search Select Class link.

setIncludeSubClass

public void setIncludeSubClass(boolean includeSubClass)
Sets to true to include subclass in a My Search searching.

Parameters:
includeSubClass - boolean true to include all sub classes in a My Search search.

setUsePopupWindow

public void setUsePopupWindow(boolean usePopupWindow)
Set how the selection page will be displayed.

Parameters:
usePopupWindow - boolean True to show selection page in a popup window, False for in place.

setEventTargetName

public void setEventTargetName(java.lang.String value)
Set event target name.

Parameters:
value - Event target name

getToolBar

public com.filenet.wcm.apps.server.presentation.ui.ToolBar getToolBar()
                                                               throws java.lang.Exception
Accessor method to return the WcmToolBar object.

Returns:
ToolBar object.
Throws:
java.lang.Exception - All errors.

setNotSelectedMessage

public void setNotSelectedMessage(com.filenet.wcm.toolkit.util.WcmString newMessage)

setSelectPageUrl

public void setSelectPageUrl(java.lang.String url)
Set the url to the select operation page. The default value is the url to the select object opeartion page

Parameters:
url - String url to the select operation page.

setInfoUrl

public void setInfoUrl(java.lang.String url)

getIconUrl

protected java.lang.String getIconUrl()

getMimeType

protected java.lang.String getMimeType()


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