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

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
All Implemented Interfaces:
IPageFlowScopeAdapter
Direct Known Subclasses:
BaseToggleSearchResultOptionsPageBean

public abstract class BaseSearchResultOptionsPageBean
extends BasePortletPageBean

Base page bean for search result options pages

Since:
7.0

Nested Class Summary
 
Nested classes/interfaces inherited from class com.webmethods.caf.faces.bean.BaseViewBean
BaseViewBean.ClientIdsContentProvider
 
Field Summary
protected  List fSortableColumnList
          List of sortable columns
protected  List fViewableColumnList
          List of viewable columns
 
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
BaseSearchResultOptionsPageBean()
           
 
Method Summary
protected  void beforeRenderResponse()
          Overrides the default behavior to load information about the available table columns
 String cancelDisplayOptions()
          Action handler for the 'Cancel' button in the search options UI.
protected abstract  String getSearchResultControlId()
          Returns the id of the search result table control
protected  String getSearchResultsViewId()
          Returns the id of the search results view
 List getSortableColumnList()
          Returns the list of sortable columns
 List getViewableColumnList()
          Returns the list of viewable columns
 boolean isSortable()
          Returns whether there are any sortable columns in the search results table
protected  void loadColumnInfo()
          Loads the column information from the search results view
protected  void loadColumnInfoForControl(String controlId, List viewableColumnList, List sortableColumnList)
          Loads the column info for the requested control
 String persistDisplayOptions()
          Action handler for the 'Save' button in the search options UI.
 
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

fSortableColumnList

protected List fSortableColumnList
List of sortable columns


fViewableColumnList

protected List fViewableColumnList
List of viewable columns

Constructor Detail

BaseSearchResultOptionsPageBean

public BaseSearchResultOptionsPageBean()
Method Detail

beforeRenderResponse

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

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

getSortableColumnList

public List getSortableColumnList()
Returns the list of sortable columns

Returns:
list of sortable columns

getViewableColumnList

public List getViewableColumnList()
Returns the list of viewable columns

Returns:
list of viewable columns

loadColumnInfo

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


loadColumnInfoForControl

protected void loadColumnInfoForControl(String controlId,
                                        List viewableColumnList,
                                        List sortableColumnList)
Loads the column info for the requested control

Parameters:
viewableColumnList - list where the viewable columns are added
sortableColumnList - list where the sortable columns are added

getSearchResultControlId

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

Returns:
the id of the search result table control

getSearchResultsViewId

protected String getSearchResultsViewId()
Returns the id of the search results view

Returns:
the id of the search results view

isSortable

public boolean isSortable()
Returns whether there are any sortable columns in the search results table

Returns:
true if there are sortable columns, false otherwise

persistDisplayOptions

public String persistDisplayOptions()
                             throws PortletModeException
Action handler for the 'Save' button in the search options UI. By default, it will persist the search options chosen by the user and switch to the 'view' portlet mode.

Returns:
status of the action handler
Throws:
PortletModeException

cancelDisplayOptions

public String cancelDisplayOptions()
                            throws PortletModeException
Action handler for the 'Cancel' button in the search options UI. By default it will switch the portlet back to the 'view' mode.

Returns:
status of the action handler
Throws:
PortletModeException