com.webmethods.caf.faces.bean.search
Class BaseToggleSearchResultOptionsPageBean

java.lang.Object
  extended by com.webmethods.caf.faces.bean.BaseFacesBean
      extended by com.webmethods.caf.faces.bean.BaseFacesSessionBean
          extended by com.webmethods.caf.faces.bean.BaseViewBean
              extended by com.webmethods.caf.faces.bean.BasePortletPageBean
                  extended by com.webmethods.caf.faces.bean.search.BaseSearchResultOptionsPageBean
                      extended by com.webmethods.caf.faces.bean.search.BaseToggleSearchResultOptionsPageBean
All Implemented Interfaces:
IPageFlowScopeAdapter

public abstract class BaseToggleSearchResultOptionsPageBean
extends BaseSearchResultOptionsPageBean

Base page bean for search result options pages that can toggle between a table view and a tree view of the search results

Since:
7.0

Nested Class Summary
 
Nested classes/interfaces inherited from class com.webmethods.caf.faces.bean.BaseViewBean
BaseViewBean.ClientIdsContentProvider
 
Field Summary
protected  List fTreeSortableColumnList
          List of sortable columns in the tree control
protected  List fTreeViewableColumnList
          List of viewable columns in the tree control
 
Fields inherited from class com.webmethods.caf.faces.bean.search.BaseSearchResultOptionsPageBean
fSortableColumnList, fViewableColumnList
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseViewBean
clientIds, initialized
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean
fExpireWithPageFlow
 
Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean
DATA_BINDING_CLIENTS, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders
 
Constructor Summary
BaseToggleSearchResultOptionsPageBean()
           
 
Method Summary
protected  void beforeRenderResponse()
          Overrides the default behavior to load information about the available tree columns
protected abstract  String getSearchResultTreeControlId()
          Returns the id of the search result table control
 List getTreeSortableColumnList()
          Returns the list of sortable columns for the tree view
 List getTreeViewableColumnList()
          Returns the list of viewable columns for the tree view
 boolean isTreeSortable()
          Returns whether there are any sortable columns in the search results tree
protected  void loadTreeColumnInfo()
          Loads the column information from the search results tree view
 
Methods inherited from class com.webmethods.caf.faces.bean.search.BaseSearchResultOptionsPageBean
cancelDisplayOptions, getSearchResultControlId, getSearchResultsViewId, getSortableColumnList, getViewableColumnList, isSortable, loadColumnInfo, loadColumnInfoForControl, persistDisplayOptions
 
Methods inherited from class com.webmethods.caf.faces.bean.BasePortletPageBean
beforeWorkspaceLoad, callInitialize, clearNavigationState, createActionUrl, createRenderUrl, getActivePreferencesBean, getPreferences, getRequestID, gotoPage, switchToPortletMode
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseViewBean
afterApplyRequestValues, afterInvokeApplication, afterPhase, afterProcessValidations, afterRenderResponse, afterRestoreView, afterUpdateModelValues, beforeApplyRequestValues, beforeInvokeApplication, beforePhase, beforeProcessValidations, beforeRestoreView, beforeUpdateModelValues, findComponent, findComponentInRoot, getApplicationScope, getClientIds, getPhaseId, getRealPath, getRequestParam, getRequestScope, getSessionScope, gotoPage, initialize, isAsyncRequest, release, resetPageFlowStorage, streamFileDataToResponse
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean
getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound
 
Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean
createMethodBinding, createValueBinding, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fTreeSortableColumnList

protected List fTreeSortableColumnList
List of sortable columns in the tree control


fTreeViewableColumnList

protected List fTreeViewableColumnList
List of viewable columns in the tree control

Constructor Detail

BaseToggleSearchResultOptionsPageBean

public BaseToggleSearchResultOptionsPageBean()
Method Detail

beforeRenderResponse

protected void beforeRenderResponse()
Overrides the default behavior to load information about the available tree columns

Overrides:
beforeRenderResponse in class BaseSearchResultOptionsPageBean
See Also:
BaseViewBean.beforeRenderResponse(), BaseSearchResultOptionsPageBean.beforeRenderResponse()

getSearchResultTreeControlId

protected abstract String getSearchResultTreeControlId()
Returns the id of the search result table control

Returns:
the id of the search result table control

loadTreeColumnInfo

protected void loadTreeColumnInfo()
Loads the column information from the search results tree view


getTreeSortableColumnList

public List getTreeSortableColumnList()
Returns the list of sortable columns for the tree view

Returns:
list of sortable columns

getTreeViewableColumnList

public List getTreeViewableColumnList()
Returns the list of viewable columns for the tree view

Returns:
list of viewable columns

isTreeSortable

public boolean isTreeSortable()
Returns whether there are any sortable columns in the search results tree

Returns:
true if there are sortable columns, false otherwise