Interface OptionSuggestable

All Superinterfaces:
Suggestable

public interface OptionSuggestable extends Suggestable
This interface defines the format of Suggest Result which are displayed on the UI. By implementing this interface one can define the format of the display text for suggestions.

Supported API: true

Extendable: true
  • Method Details

    • getFormatedSuggestions

      void getFormatedSuggestions(Collection<ChoiceSuggestionBean> suggestBeans)
      API to format displayText, additionalText and valueText shown in the UI for suggest results. This API calls addSuggestions method to form Collection of SuggestResults

      Supported API: true
      Parameters:
      suggestBeans - - contains choice,option and Alias information.
    • constructSuggestions

      void constructSuggestions(SuggestParms suggestParms)
      API to to form Collection of ChoiceSuggestionBean which is used to create suggestion results.

      Supported API: true
      Parameters:
      suggestParms - - contains the searchTerm -which is the text entered in the UI for search, maxResult-which is the number of results to be seen on the UI, and contextId-which gives the context from where the search is launched