Class SearchStateOptions

java.lang.Object
com.webmethods.caf.faces.search.query.SearchStateOptions
All Implemented Interfaces:
ISearchStateOptions

public class SearchStateOptions extends Object implements ISearchStateOptions
Default implementation of the ISearchStateOptions interface
  • Field Details

    • refinedSearch

      protected boolean refinedSearch
    • advancedSearch

      protected boolean advancedSearch
    • keywordsFieldAvailable

      protected boolean keywordsFieldAvailable
    • useOrConditionFieldAvailable

      protected boolean useOrConditionFieldAvailable
    • maxResultsFieldAvailable

      protected boolean maxResultsFieldAvailable
    • noMaxResults

      protected boolean noMaxResults
    • maxResults

      protected Integer maxResults
  • Constructor Details

    • SearchStateOptions

      public SearchStateOptions()
  • Method Details

    • isRefinedSearch

      public boolean isRefinedSearch()
      Description copied from interface: ISearchStateOptions
      Return true if the search is a refined search
      Specified by:
      isRefinedSearch in interface ISearchStateOptions
      Returns:
      true for a refined search, false for a simple keyword search
    • setRefinedSearch

      public void setRefinedSearch(boolean refinedSearch)
      Parameters:
      refinedSearch - The refinedSearch to set.
    • isAdvancedSearch

      public boolean isAdvancedSearch()
      Description copied from interface: ISearchStateOptions
      Return true if the search originated from the 'Advanced' searchbar tab
      Specified by:
      isAdvancedSearch in interface ISearchStateOptions
      Returns:
      true for an advanced search, false otherwise
    • setAdvancedSearch

      public void setAdvancedSearch(boolean advancedSearch)
      Parameters:
      advancedSearch - The advancedSearch to set.
    • isKeywordsFieldAvailable

      public boolean isKeywordsFieldAvailable()
      Description copied from interface: ISearchStateOptions
      Returns true of the keywords field is available and visible to the user performing the search
      Specified by:
      isKeywordsFieldAvailable in interface ISearchStateOptions
      Returns:
      true if the keywords field is available, false otherwise
    • setKeywordsFieldAvailable

      public void setKeywordsFieldAvailable(boolean keywordsFieldAvailable)
      Parameters:
      keywordsFieldAvailable - The keywordsFieldAvailable to set.
    • isUseOrConditionFieldAvailable

      public boolean isUseOrConditionFieldAvailable()
      Description copied from interface: ISearchStateOptions
      Returns true of the 'AND/OR' search condition field is available and visible to the user performing the search
      Specified by:
      isUseOrConditionFieldAvailable in interface ISearchStateOptions
      Returns:
      true if the search condition field is available, false otherwise
    • setUseOrConditionFieldAvailable

      public void setUseOrConditionFieldAvailable(boolean useOrConditionFieldAvailable)
      Parameters:
      useOrConditionFieldAvailable - The useOrConditionFieldAvailable to set.
    • isMaxResultsFieldAvailable

      public boolean isMaxResultsFieldAvailable()
      Description copied from interface: ISearchStateOptions
      Returns whether the max results field is available and visible to the user performing the search
      Specified by:
      isMaxResultsFieldAvailable in interface ISearchStateOptions
      Returns:
      true if the max results field is available, false otherwise
    • setMaxResultsFieldAvailable

      public void setMaxResultsFieldAvailable(boolean maxResultsFieldAvailable)
      Parameters:
      maxResultsFieldAvailable - The maxResultsFieldAvailable to set.
    • isNoMaxResults

      public boolean isNoMaxResults()
      Description copied from interface: ISearchStateOptions
      Returns whether the no max results mode is active
      Specified by:
      isNoMaxResults in interface ISearchStateOptions
      Returns:
      true for no max results limiting, false otherwise
    • setNoMaxResults

      public void setNoMaxResults(boolean noMaxResults)
      Parameters:
      noMaxResults - The noMaxResults to set.
    • getMaxResults

      public Integer getMaxResults()
      Description copied from interface: ISearchStateOptions
      Returns the maximum number of results to allow in the search results table
      Specified by:
      getMaxResults in interface ISearchStateOptions
      Returns:
      Returns the maxResults.
    • setMaxResults

      public void setMaxResults(Integer maxResults)
      Parameters:
      maxResults - The maxResults to set.