B25.SearchResult

Overview

This class represents one result shown to the user when they search in a lookup or a list.

Your search handlers are expected to return SearchResults bundled together in a B25.SearchResultCollection instance. You can either create your own collection, or get one using B25.SearchContext.getDefaultResults().

Example

1 2 3 4 5 6 7 global with sharing class MySearchResults extends B25.SearchHandler { global override B25.SearchResultCollection getSearchResults(B25.SearchContext context) { B25.SearchResultCollection collection = new B25.SearchResultCollection(); collection.addSearchResult(new B25.SearchResult('some-identifier', 'Hello World!')); return collection; } }

Example Result

 

Methods

setSelectable

1 B25.SearchResult setSelectable(Boolean selectable)

Sets the ‘selectable’ property for this result. A result that is not selectable can’t be selected by the user. This is useful for displaying information to the user. The default value is true.

Return value: B25.SearchResult

Parameters:

Name

Type

Description

selectable

Boolean

The value for the ‘selectable’ property.


getSelectable

1 Boolean getSelectable()

Gets the ‘selectable’ property for this result. A result that is not selectable can’t be selected by the user. This is useful for displaying information to the user. The default value is true.

Return value: Boolean


setPreventDefault

1 B25.SearchResult setPreventDefault(Boolean preventDefault)

Sets the ‘prevent default’ property for this result. A result that has ‘prevent default’ enabled, will not be added to the list when selected. This is useful for showing options which should trigger custom logic instead of adding a record. The default value is false.

Return value: B25.SearchResult

Parameters:

Name

Type

Description

preventDefault

Boolean

The value for the ‘prevent default’ property.


getPreventDefault

1 Boolean getPreventDefault()

Gets the ‘prevent default’ property for this result. A result that has ‘prevent default’ enabled, will not be added to the list when selected. This is useful for showing options which should trigger custom logic instead of adding a record. The default value is false.

Return value: Boolean


setIcon

1 B25.SearchResult setIcon(String iconName)

Sets this result’s icon. You can use icons from this page: https://www.lightningdesignsystem.com/icons/, except for the icons in the Action category. Reference icons by combining the category and the icon name, with a colon in between. For example, 'standard:contact' will give you the contact icon from the Standard category.

Return value: B25.SearchResult

Parameters:

Name

Type

Description

iconName

String

The name of the icon.


getIcon

1 String getIcon()

Gets this result’s icon.

Return value: String


setMetaText

1 B25.SearchResult setMetaText(String metaText)

This method sets the meta text for the result.

Return value: B25.SearchResult

Parameters:

Name

Type

Description

metaText

String

The text that you want to set.


getMetaText

1 String getMetaText()

This method gets the meta text for the result.

Return value: String


getId

1 String getId()

This method gets the Id for the result.

Return value: String

 


getLabel

1 String getLabel()

This method gets the label for the result.

Return value: String