B25.SearchContext

Overview

Example

This search handler adds an extra query condition to the SearchContext, in order to only show Contacts related to the selected Account.

1 2 3 4 5 6 7 8 9 10 global class MyContactSearch implements B25.SearchContext.SearchHandler { public B25.SearchResult.Collection getSearchResults(B25.SearchContext searchContext) { Id accountId = searchContext.getReservation().B25__Account__c; if (accountId != null) { searchContext.addCondition('AND Account = \' + accountId + '\''); } List<B25.SearchResult> results = searchContext.getDefaultResults(); return new B25.SearchResult.Collection(results); } }

Methods

getSearchTerm

1 String getSearchTerm()

Returns the search term that the user has typed.

Return value: String


getDefaultResults

1 B25.SearchResult.Collection getDefaultResults()

Returns a Collection wrapping the results that would be generated by Booker25, modified by any conditions defined (also see addCondition).

To access the individual results, call getResults() on the Collection.

Return value: B25.SearchResult.Collection


getForm

1 B25.Form getForm()

Returns the Form object that the user has performed the search on. This can be useful to get more information about the other fields that have been filled in on the reservation, using the Form.getReservation method.

Return value: B25.Form


getConditions

1 List<String> getConditions()

Returns the conditions that have already been defined. These will narrow down the search results returned by getDefaultResults(). As this is a reference to the actual list, you can still manipulate this list (such as adding or removing entries) before calling getDefaultResults().

Return value: List<String>


addCondition

1 void addCondition(String condition)

Adds a condition to narrow down the search results returned by getDefaultResults(). Functionally identical to calling getConditions().add(condition).

Dynamic references to parameters (i.e. ‘Account = :accountId’) will not work. Make sure to escape ids in the following way:

1 addCondition('Account = \'' + accountId + '\'');

Parameters:

Name

Type

Description

condition

String

The condition that you want to add.


getSearchFields

1 List<String> getSearchFields()

Returns the fields that will be queried for the search term.

Return value: List<String>


addSearchField

1 void addSearchField(String fieldName)

Adds a field to be queried for the search term. For example, if you also want to search for contacts by phone number, do the following:

1 2 searchContext.addSearchField('HomePhone'); searchContext.addSearchField('MobilePhone');

If the user performing the search has no access to any of these fields, they are ignored. So if the user has no access to the MobilePhone field in the example above, only the HomePhone field is searched.

You can also search for fields on related records. For example, if you also want to search for contacts by account name, do the following:

1 searchContext.addSearchField('Account.Name');

Parameters:

Name

Type

Description

fieldName

String

The API name of a field that you want to be searched.


setLabelTemplate

1 void setLabelTemplate(String template, List<String> mergeFields)

This method lets you define what the label of each search result should be, based on one or more merge fields. For example, if you want to display your contact labels like this: LastName, FirstName (AccountName), you would do the following:

1 searchContext.setLabelTemplate('{0}, {1} ({2})', new List<String>{'LastName', 'FirstName', 'Account.Name'});

The above would result in an output like this:

If the user performing the search has no access to any of these fields, they are replaced with an empty string.

By default (so if you would never call this method) only the record name is displayed as the label. This is the same as doing the following:

1 searchContext.setLabelTemplate('{0}', new List<String>{'Name'});

Parameters:

Name

Type

Description

template

String

A string containing numbered placeholders which will be replaced with actual values in the final result.

mergeFields

List<String>

An ordered list of merge field API names. These will replace the matching placeholders in the template with each record’s actual values.


setMetaTemplate

1 void setMetaTemplate(String template, List<String> mergeFields)

Similar to the above method setLabelTemplate, except this method lets you define the meta text instead of the label. The meta text is displayed under the label, and can provide more information about a record. For example, you could use it to display a contacts phone number:

1 searchContext.setMetaTemplate('Mobile: {0}', new List<String>{'MobilePhone'});

The above would result in an output like this:

If the user performing the search has no access to any of these fields, they are replaced with an empty string.

Parameters:

Name

Type

Description

template

String

A string containing numbered placeholders which will be replaced with actual values in the final result.

mergeFields

List<String>

An ordered list of merge field API names. These will replace the matching placeholders in the template with each record’s actual values.