com.webmethods.caf.faces.search.saved

Interface ISavedSearchProvider

All Known Implementing Classes:

BaseSavedSearchProvider, DboSavedSearchProvider, InMemorySavedSearchProvider, SimpleSavedSearchProvider, SimpleWebAppSavedSearchProvider

public interface ISavedSearchProvider

Interface that all implementations of ISavedSearchProvider implementations must implement.

Method Summary

Modifier and Type	Method and Description
ISavedSearch	createSavedSearch() Creates a new saved search object
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
boolean	getSupportsPublicSavedSearch() Returns whether is saved search provider supports public saved searches
boolean	hasSavedSearches() Returns whether the saved search provider has any saved searches
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

Method Detail

setSearchQueryFactory

void setSearchQueryFactory(ISearchQueryFactory factory)

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

Parameters:

factory - the factory to use to create search query objects

hasSavedSearches

boolean hasSavedSearches()

Returns whether the saved search provider has any saved searches

Returns:

true if saved searches are available, false otherwise

createSavedSearch

ISavedSearch createSavedSearch()

Creates a new saved search object

Returns:

new saved search object

getSavedSearches

ISavedSearch[] getSavedSearches()

Get array of all the saved searches

Returns:

array of all saved searches

getSavedSearch

ISavedSearch getSavedSearch(String savedSearchID)

Gets a saved search

Parameters:

savedSearchID - the id of the saved search to get

Returns:

the saved search or null if it is not found

saveSearch

void saveSearch(ISavedSearch savedSearch)

Save a search

Parameters:

savedSearch - the saved search to save

updateSavedSearch

void updateSavedSearch(String savedSearchID,
                       ISavedSearch savedSearch)

Updates a saved search

Parameters:

savedSearchID - the id of the saved search to update

savedSearch - the saved search to save

deleteSavedSearch

void deleteSavedSearch(String savedSearchID)

Deletes a saved search

Parameters:

savedSearchID - the id of the saved search to delete

getSupportsPublicSavedSearch

boolean getSupportsPublicSavedSearch()

Returns whether is saved search provider supports public saved searches

Returns:

true if public saved searches are supported, false otherwise