SBQQ.ProductSearchPlugin Product Search Methods

Use these methods for a Product Search implementation of SBQQ.ProductSearchPlugin.

  • getAdditionalSearchFilters(quote, fieldValuesMap)
    Appends a WHERE clause to the SOQL query used for the product search, so that you can further refine a user's search input. Salesforce CPQ calls this method only when isSearchCustom returns FALSE.
  • getFilterDefaultValue(quote, fieldName)
    Determines the value for the initial search. Salesforce CPQ calls this implemented method for each input field.
  • isFilterHidden(quote, fieldName)
    Determines the visibility of a filter in the UI. Return True to hide the filter and False to let users see the filter. Salesforce CPQ calls this implemented method for each search input field.
  • isSearchCustom(quote, fieldValuesMap)
    Called after isFilterHidden and getFilterDefaulValue. Returns True if the plugin uses custom searching or False if the plugin uses enhanced searching.
  • search(quote, fieldValuesMap)
    Overrides the entire user search input. Salesforce CPQ calls this method only when isSearchCustom returns TRUE.