com.webmethods.caf.faces.search.query
Interface ISearchStateOptions

public interface ISearchStateOptions

Interface that implementations of search state options must implement

Method Summary

Integer	getMaxResults() Returns the maximum number of results to allow in the search results table
boolean	isAdvancedSearch() Return true if the search originated from the 'Advanced' searchbar tab
boolean	isKeywordsFieldAvailable() Returns true of the keywords field is available and visible to the user performing the search
boolean	isMaxResultsFieldAvailable() Returns whether the max results field is available and visible to the user performing the search
boolean	isNoMaxResults() Returns whether the no max results mode is active
boolean	isRefinedSearch() Return true if the search is a refined search
boolean	isUseOrConditionFieldAvailable() Returns true of the 'AND/OR' search condition field is available and visible to the user performing the search

Method Detail

isRefinedSearch

boolean isRefinedSearch()

Return true if the search is a refined search

Returns:

true for a refined search, false for a simple keyword search

isAdvancedSearch

boolean isAdvancedSearch()

Return true if the search originated from the 'Advanced' searchbar tab

Returns:

true for an advanced search, false otherwise

isKeywordsFieldAvailable

boolean isKeywordsFieldAvailable()

Returns true of the keywords field is available and visible to the user performing the search

Returns:

true if the keywords field is available, false otherwise

isUseOrConditionFieldAvailable

boolean isUseOrConditionFieldAvailable()

Returns true of the 'AND/OR' search condition field is available and visible to the user performing the search

Returns:

true if the search condition field is available, false otherwise

isMaxResultsFieldAvailable

boolean isMaxResultsFieldAvailable()

Returns whether the max results field is available and visible to the user performing the search

Returns:

true if the max results field is available, false otherwise

isNoMaxResults

boolean isNoMaxResults()

Returns whether the no max results mode is active

Returns:

true for no max results limiting, false otherwise

getMaxResults

Integer getMaxResults()

Returns the maximum number of results to allow in the search results table

Returns:

max number of results