Class SuggestOracle.Response

java.lang.Object
com.google.gwt.user.client.ui.SuggestOracle.Response
All Implemented Interfaces:
IsSerializable
Enclosing class:
SuggestOracle

public static class SuggestOracle.Response extends Object implements IsSerializable
SuggestOracle response.

Can optionally have truncation information provided. To indicate that there are more results but the number is not known, use:

response.setMoreSuggestions(true);

Or to indicate more results with an exact number, use:

response.setMoreSuggestionsCount(102);

  • Constructor Details

  • Method Details

    • getMoreSuggestionsCount

      public int getMoreSuggestionsCount()
      Gets how many more suggestions there are.
      Returns:
      the count. if there no more suggestions or the number of more suggestions is unknown, returns 0.
    • getSuggestions

      public Collection<? extends SuggestOracle.Suggestion> getSuggestions()
      Gets the collection of suggestions. Each suggestion must implement the SuggestOracle.Suggestion interface.
      Returns:
      the collection of suggestions
    • hasMoreSuggestions

      public boolean hasMoreSuggestions()
      Gets whether or not the suggestion list was truncated due to the SuggestOracle.Request.getLimit().
    • setMoreSuggestions

      public void setMoreSuggestions(boolean moreSuggestions)
      Sets whether or not the suggestion list was truncated due to the SuggestOracle.Request.getLimit().
    • setMoreSuggestionsCount

      public void setMoreSuggestionsCount(int count)
      Sets whether or not the suggestion list was truncated due to the SuggestOracle.Request.getLimit(), by providing an exact count of remaining suggestions.
      Parameters:
      count - number of truncated suggestions. Pass 0 to indicate there are no other suggestions, which is equivalent to setMoreSuggestions(false).
    • setSuggestions

      public void setSuggestions(Collection<? extends SuggestOracle.Suggestion> suggestions)
      Sets the suggestions for this response. Each suggestion must implement the SuggestOracle.Suggestion interface.
      Parameters:
      suggestions - the suggestions