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

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.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.presentation.ui.GenericListView
                          extended bycom.filenet.wcm.apps.server.presentation.ui.ItemsListView
                              extended bycom.filenet.wcm.apps.server.ui.WcmItemsListView
                                  extended bycom.filenet.wcm.apps.server.ui.info.WcmTemplatesInfoPage
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 WcmTemplatesInfoPage
extends WcmItemsListView
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

Info page for showing Security Templates of a Security Policy.


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
config, contextMenuHelper, contextMenuVersionSeriesMode, showPageSizeDropDown, showReleaseOnly, sitePrefs
 
Fields inherited from class com.filenet.wcm.apps.server.presentation.ui.ItemsListView
KEY_COLUMN, KEY_DIRECTION, sortEvent
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmTemplatesInfoPage(int type)
          Constructor sets the default type, and name
 
Method Summary
 java.lang.String getFormName()
          No form on this page.
 java.util.Iterator getValidationErrors()
          Unused
 void initialize()
          Initializes state values.
 boolean isApplyButtonRequired()
          This page is read only so does not require an apply button.
 boolean isFinished()
          Returns true if any template has been defined.
 boolean isModified()
          This page is read only when in info page mode, so it cannot be modified.
 void onLaunchTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onRemoveTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Removes the template with the applyStateId indicated in the request params.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Merge templates if necessary, set XML and XSL parameters and any other setup required before rendering.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          resets any state information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Info Page or Template wizard handles save
 boolean panelValidate()
          Checks to see if there are any security templates defined and throws an exception if not.
 void render(java.io.Writer w)
          Renders the security templates info.
 void reset()
          Resets state information.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmItemsListView
configListViewPrefs, configNameProperties, configNameProperties, configureContextMenu, configureDateFormat, getXSLTemplate, onPageSizeChange, onViewChange, setCustomObjectNameProperty, setDocumentNameProperty, setErrorMessage, setErrorMessage, setFolderNameProperty, setShowPageSizeDropDown, setShowReleaseOnly, setVersionSeriesMode
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.ItemsListView
configureDisplayNameUtil, getSortColumn, getSortOrder, onSort, setAddItemLinkUrl, setAvailablePageSizes, setColumnAlignments, setColumnAlignments, setColumnLabels, setColumnLabels, setCurrentPageURL, setDefaultPropertyFormatString, setDetailedView, setDisableViewFormatDropDown, setDisplayedProperties, setDisplayedProperties, setEnableSorting, setHideButtonsInInfo, setIncludeIdForGetContent, setInfoLinkMode, setMagazineViewDefaultProperty, setMagazineViewFormatString, setMimeIcons, setMode, setMultiSelectLinkHTML, setSelectLinkEventURL, setSelectLinkTitle, setSelectLinkURL, setSelectVersionLinkURL, setShowItemsFound, setShowRankingColumn, setShowSelectCurrentVersionLink, setShowSelectReleasedVersionLink, setShowStripesInMagazineView, setShowSummary, setShowSummaryViewOption, setShowViewFormatDropDown, setSortColumn, setSortOrder, setStateIcons, setVersionNumbers, setVersionStatusLabels, setVersionStatusLabels, sort
 
Methods inherited from class com.filenet.wcm.apps.server.presentation.ui.GenericListView
getCurrentPage, onPageChange, setCurrentPage, setFirstDisplayedItem, setItemsCount, setLastDisplayedItem, setNameProperty, setNoItemsText, setNotItemsTextString, setPageSize, setPagingLabel, setSelectedObjects
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
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

WcmTemplatesInfoPage

public WcmTemplatesInfoPage(int type)
                     throws java.lang.Exception
Constructor sets the default type, and name

Parameters:
type - sets the WcmPageMode
Throws:
java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes state values.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmItemsListView
Throws:
java.lang.Exception - If a Data Provider was not found.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the security templates info.

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

getFormName

public java.lang.String getFormName()
No form on this page.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Returns:
null always.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Merge templates if necessary, set XML and XSL parameters and any other setup required before rendering.

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

onRemoveTemplate

public void onRemoveTemplate(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
Removes the template with the applyStateId indicated in the request params.

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

onLaunchTemplate

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

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Info Page or Template wizard handles save

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

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Checks to see if there are any security templates defined and throws an exception if not. If we have not shown this page but want to pass, we still need to merge the templates.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
true if no Exceptions were thrown.
Throws:
java.lang.Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Unused

Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
null

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
resets any state information.

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

reset

public void reset()
           throws java.lang.Exception
Resets state information.

Throws:
java.lang.Exception

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Returns true if any template has been defined.

Returns:
true if any template has been defined.
Throws:
java.lang.Exception

isModified

public boolean isModified()
                   throws java.lang.Exception
This page is read only when in info page mode, so it cannot be modified.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
false always.
Throws:
java.lang.Exception

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
This page is read only so does not require an apply button.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
false always.
Throws:
java.lang.Exception


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