com.webmethods.caf.faces.search.saved

Class BaseSavedSearchProvider

java.lang.Object

com.webmethods.caf.faces.search.saved.BaseSavedSearchProvider

All Implemented Interfaces:

ISavedSearchProvider, Serializable

Direct Known Subclasses:

InMemorySavedSearchProvider, SimpleSavedSearchProvider, SimpleWebAppSavedSearchProvider

public abstract class BaseSavedSearchProvider
extends Object
implements ISavedSearchProvider, Serializable

Base implementation of the ISavedSearchProvider interface.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	fSavedSearchCaseInsensitiveNames
protected Map<String,ISavedSearch>	fSavedSearchesMap
protected ISearchQueryFactory	fSearchQueryFactory

Constructor Summary

Constructors

Constructor and Description
BaseSavedSearchProvider(ISearchQueryFactory searchQueryFactory)

Method Summary

Modifier and Type	Method and Description
ISavedSearch	createSavedSearch() Creates and returns a new SavedSearch object for the SearchBar control.
void	deleteSavedSearch(String savedSearchID) Deletes a saved search
ISavedSearch	getSavedSearch(String savedSearchID) Gets a saved search
ISavedSearch[]	getSavedSearches() Get array of all the saved searches
protected Map<String,ISavedSearch>	getSavedSearchesMap()
protected abstract String	getSavedSearchesString()
boolean	getSupportsPublicSavedSearch() Returns whether is saved search provider supports public saved searches
boolean	hasSavedSearches() Returns whether the saved search provider has any saved searches
protected abstract void	persistSavedSearchesString()
void	saveSearch(ISavedSearch savedSearch) Save a search
void	setSearchQueryFactory(ISearchQueryFactory factory) Sets the factory that should be used to create search query objects
void	updateSavedSearch(String savedSearchID, ISavedSearch savedSearch) Updates a saved search

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fSearchQueryFactory

protected ISearchQueryFactory fSearchQueryFactory

fSavedSearchesMap

protected Map<String,ISavedSearch> fSavedSearchesMap

fSavedSearchCaseInsensitiveNames

protected Map<String,String> fSavedSearchCaseInsensitiveNames

Constructor Detail

BaseSavedSearchProvider

public BaseSavedSearchProvider(ISearchQueryFactory searchQueryFactory)

Method Detail

createSavedSearch

public ISavedSearch createSavedSearch()

Creates and returns a new SavedSearch object for the SearchBar control. Sub-classes may override to provide an alternate ISavedSearch implementation.

Specified by:

createSavedSearch in interface ISavedSearchProvider

Returns:

Returns a new ISavedSearch object

deleteSavedSearch

public void deleteSavedSearch(String savedSearchID)

Description copied from interface: ISavedSearchProvider

Deletes a saved search

Specified by:

deleteSavedSearch in interface ISavedSearchProvider

Parameters:

savedSearchID - the id of the saved search to delete

getSavedSearch

public ISavedSearch getSavedSearch(String savedSearchID)

Description copied from interface: ISavedSearchProvider

Gets a saved search

Specified by:

getSavedSearch in interface ISavedSearchProvider

Parameters:

savedSearchID - the id of the saved search to get

Returns:

the saved search or null if it is not found

getSavedSearches

public ISavedSearch[] getSavedSearches()

Description copied from interface: ISavedSearchProvider

Get array of all the saved searches

Specified by:

getSavedSearches in interface ISavedSearchProvider

Returns:

array of all saved searches

getSupportsPublicSavedSearch

public boolean getSupportsPublicSavedSearch()

Description copied from interface: ISavedSearchProvider

Returns whether is saved search provider supports public saved searches

Specified by:

getSupportsPublicSavedSearch in interface ISavedSearchProvider

Returns:

true if public saved searches are supported, false otherwise

hasSavedSearches

public boolean hasSavedSearches()

Description copied from interface: ISavedSearchProvider

Returns whether the saved search provider has any saved searches

Specified by:

hasSavedSearches in interface ISavedSearchProvider

Returns:

true if saved searches are available, false otherwise

saveSearch

public void saveSearch(ISavedSearch savedSearch)

Description copied from interface: ISavedSearchProvider

Save a search

Specified by:

saveSearch in interface ISavedSearchProvider

Parameters:

savedSearch - the saved search to save

setSearchQueryFactory

public void setSearchQueryFactory(ISearchQueryFactory factory)

Description copied from interface: ISavedSearchProvider

Sets the factory that should be used to create search query objects

Specified by:

setSearchQueryFactory in interface ISavedSearchProvider

Parameters:

factory - the factory to use to create search query objects

updateSavedSearch

public void updateSavedSearch(String savedSearchID,
                              ISavedSearch savedSearch)

Description copied from interface: ISavedSearchProvider

Updates a saved search

Specified by:

updateSavedSearch in interface ISavedSearchProvider

Parameters:

savedSearchID - the id of the saved search to update

savedSearch - the saved search to save

getSavedSearchesString

protected abstract String getSavedSearchesString()

persistSavedSearchesString

protected abstract void persistSavedSearchesString()

getSavedSearchesMap

protected Map<String,ISavedSearch> getSavedSearchesMap()