Package com.webmethods.caf.faces.bean.search

Class BaseSearchBarPageBean

java.lang.Object

com.webmethods.caf.faces.bean.BaseFacesBean

com.webmethods.caf.faces.bean.BaseFacesSessionBean

com.webmethods.caf.faces.bean.BaseViewBean

com.webmethods.caf.faces.bean.BasePortletPageBean

com.webmethods.caf.faces.bean.search.BaseSearchBarPageBean

All Implemented Interfaces:

IPageFlowScopeAdapter, ISearchBarPageBean, ISearchPageBean, Serializable, EventListener, PhaseListener, HttpSessionBindingListener

Direct Known Subclasses:

BaseTaskInboxBarPageBean

public abstract class BaseSearchBarPageBean
extends BasePortletPageBean
implements ISearchBarPageBean, ISearchPageBean

Base page bean for views containing a search bar control

Since:

7.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.bean.BaseViewBean

BaseViewBean.ClientIdsContentProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected ISavedSearchProvider	fSavedSearchProvider	Reference to the current saved search provider
protected ISearchOptionsManager	fSearchOptionsManager	Reference to the current search options manager
protected ISearchQueryFactory	fSearchQueryFactory	Reference to the current search query factory

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, EMPTY_RESOURCES, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders

Constructor Summary

Constructors

Constructor	Description
BaseSearchBarPageBean()	Default Constructor

Method Summary

Modifier and Type	Method	Description
ISavedSearch	getActiveSavedSearch()	Gets the active saved search object for the SearchBar control.
ISearchQuery	getActiveSearchQuery()	Gets the active search query object for the SearchBar control.
protected SearchBar	getSafeSearchBarControl()	Wrapper around the getSearchBarControl method that throws an exception if the SearchBar value is null
ISavedSearchProvider	getSavedSearchProvider()	Creates and returns implementation of ISavedSearchProvider
abstract SearchBar	getSearchBarControl()	Retrieves the SearchBar control for this page
ISearchOptionsManager	getSearchOptionsManager()	Creates and returns implementation of ISearchOptionsManager
ISearchQueryFactory	getSearchQueryFactory()	Creates and returns implementation of ISearchQueryFactory
boolean	isSearchBarOnAdvancedTab()	Returns true if the active searchbar tab is the the 'Advanced' tab
boolean	isSearchBarOnOptionsTab()	Returns true if the active searchbar tab is the the 'Options' tab
boolean	isSearchBarOnSavedTab()	Returns true if the active searchbar tab is the the 'Saved' tab
boolean	isSearchBarOnSimpleTab()	Returns true if the active searchbar tab is the the 'Search' tab
void	loadSearchQueryDefaults(ISearchQuery searchQuery)	Loads default values into search query

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, beforeRenderResponse, beforeRestoreView, beforeUpdateModelValues, findComponent, findComponentInRoot, getApplicationScope, getClientIds, getPhaseId, getRealPath, getRequestParam, getRequestScope, getSessionScope, gotoPage, initialize, isAsyncRequest, preRenderResponse, 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, createMethodExpression, createValueBinding, createValueExpression, createValueExpression, 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 Details

fSavedSearchProvider

protected transient ISavedSearchProvider fSavedSearchProvider

Reference to the current saved search provider

fSearchQueryFactory

protected transient ISearchQueryFactory fSearchQueryFactory

Reference to the current search query factory

fSearchOptionsManager

protected transient ISearchOptionsManager fSearchOptionsManager

Reference to the current search options manager

Constructor Details

BaseSearchBarPageBean

public BaseSearchBarPageBean()

Default Constructor

Method Details

getSavedSearchProvider

public ISavedSearchProvider getSavedSearchProvider()

Description copied from interface: ISearchBarPageBean

Creates and returns implementation of ISavedSearchProvider

Specified by:

getSavedSearchProvider in interface ISearchBarPageBean

getSearchQueryFactory

public ISearchQueryFactory getSearchQueryFactory()

Description copied from interface: ISearchBarPageBean

Creates and returns implementation of ISearchQueryFactory

Specified by:

getSearchQueryFactory in interface ISearchBarPageBean

getSearchOptionsManager

public ISearchOptionsManager getSearchOptionsManager()

Description copied from interface: ISearchBarPageBean

Creates and returns implementation of ISearchOptionsManager

Specified by:

getSearchOptionsManager in interface ISearchBarPageBean

isSearchBarOnSimpleTab

public boolean isSearchBarOnSimpleTab()

Returns true if the active searchbar tab is the the 'Search' tab

Returns:

true if the active searchbar tab is the 'Search' tab

isSearchBarOnAdvancedTab

public boolean isSearchBarOnAdvancedTab()

Returns true if the active searchbar tab is the the 'Advanced' tab

Returns:

true if the active searchbar tab is the 'Advanced' tab

isSearchBarOnOptionsTab

public boolean isSearchBarOnOptionsTab()

Returns true if the active searchbar tab is the the 'Options' tab

Returns:

true if the active searchbar tab is the 'Options' tab

isSearchBarOnSavedTab

public boolean isSearchBarOnSavedTab()

Returns true if the active searchbar tab is the the 'Saved' tab

Returns:

true if the active searchbar tab is the 'Saved' tab

getSearchBarControl

public abstract SearchBar getSearchBarControl()

Retrieves the SearchBar control for this page

Returns:

SearchBar control for the page

loadSearchQueryDefaults

public void loadSearchQueryDefaults(ISearchQuery searchQuery)

Loads default values into search query

Specified by:

loadSearchQueryDefaults in interface ISearchBarPageBean

getSafeSearchBarControl

protected SearchBar getSafeSearchBarControl()

Wrapper around the getSearchBarControl method that throws an exception if the SearchBar value is null

Returns:

SearchBar control for the page

getActiveSearchQuery

public ISearchQuery getActiveSearchQuery()

Gets the active search query object for the SearchBar control.

Specified by:

getActiveSearchQuery in interface ISearchPageBean

Returns:

Returns the activeSearchQuery.

getActiveSavedSearch

public ISavedSearch getActiveSavedSearch()

Gets the active saved search object for the SearchBar control.

Returns:

Returns the activeSavedSearch.