{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"901b38b7-eb1a-4c13-8c8b-d75fba205483"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"6208b174-cebf-40a5-8d8f-debba319a84a"},"content":[{"type":"paragraph","content":[{"text":"This class represents a search being performed by the user. It allows you to get more information about the context of the search, as well as narrowing down the search results with additional conditions.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example","type":"text"}]},{"type":"paragraph","content":[{"text":"This search handler adds an extra query condition to the SearchContext, in order to only show Contacts related to the selected Account.","type":"text"}]},{"type":"codeBlock","content":[{"text":"global class MyContactSearch extends B25.SearchHandler {\n global override B25.SearchResultCollection getSearchResults(B25.SearchContext searchContext) {\n Id accountId = searchContext.getForm().getReservation().B25__Account__c;\n if (accountId != null) {\n searchContext.addCondition('AND Account = \\'' + accountId + '\\'');\n }\n return searchContext.getDefaultResults();\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Methods","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"getSearchTerm","type":"text"}]},{"type":"codeBlock","content":[{"text":"String getSearchTerm()","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the search term that the user has typed. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Return value:","type":"text","marks":[{"type":"strong"}]},{"text":" String","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getDefaultResults","type":"text"}]},{"type":"codeBlock","content":[{"text":"B25.SearchResultCollection getDefaultResults()","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns a Collection wrapping the results that would be generated by GoMeddo, modified by any conditions defined (also see ","type":"text"},{"text":"addCondition","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]},{"type":"paragraph","content":[{"text":"To access the individual results, call ","type":"text"},{"text":"getResults()","type":"text","marks":[{"type":"code"}]},{"text":" on the Collection.","type":"text"}]},{"type":"paragraph","content":[{"text":"Return value:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"B25.SearchResult.Collection","type":"text","marks":[{"type":"link","attrs":{"href":"https://gomeddo.atlassian.net/wiki/spaces/BPD/pages/1970307096"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getForm","type":"text"}]},{"type":"codeBlock","content":[{"text":"B25.Form getForm()","type":"text"}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"Form.getReservation method","type":"text","marks":[{"type":"link","attrs":{"href":"https://gen25-jira.atlassian.net/wiki/spaces/BPD/pages/1875181600/B25.Form#getReservation"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Return value:","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"B25.Form","type":"text","marks":[{"type":"link","attrs":{"href":"https://gomeddo.atlassian.net/wiki/spaces/BPD/pages/1875181600"}}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getConditions","type":"text"}]},{"type":"codeBlock","content":[{"text":"List getConditions()","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the conditions that have already been defined. These will narrow down the search results returned by ","type":"text"},{"text":"getDefaultResults()","type":"text","marks":[{"type":"code"}]},{"text":". As this is a reference to the actual list, you can still manipulate this list (such as adding or removing entries) before calling ","type":"text"},{"text":"getDefaultResults()","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Return value: ","type":"text","marks":[{"type":"strong"}]},{"text":"List","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"addCondition","type":"text"}]},{"type":"codeBlock","content":[{"text":"void addCondition(String condition)","type":"text"}]},{"type":"paragraph","content":[{"text":"Adds a condition to narrow down the search results returned by ","type":"text"},{"text":"getDefaultResults()","type":"text","marks":[{"type":"code"}]},{"text":". Functionally identical to calling ","type":"text"},{"text":"getConditions().add(condition)","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Dynamic references to parameters (i.e. ","type":"text"},{"text":"‘Account = :accountId’","type":"text","marks":[{"type":"code"}]},{"text":") will not work. Make sure to escape ids in the following way:","type":"text"}]},{"type":"codeBlock","content":[{"text":"addCondition('Account = \\'' + accountId + '\\'');","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"b2695300-b5de-46c6-8d73-b5399922c02a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"condition","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"The condition that you want to add.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"getSearchFields","type":"text"}]},{"type":"codeBlock","content":[{"text":"List getSearchFields()","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the fields that will be queried for the search term.","type":"text"}]},{"type":"paragraph","content":[{"text":"Return value: ","type":"text","marks":[{"type":"strong"}]},{"text":"List","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"addSearchField","type":"text"}]},{"type":"codeBlock","content":[{"text":"void addSearchField(String fieldName)","type":"text"}]},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.addSearchField('HomePhone');\nsearchContext.addSearchField('MobilePhone');","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.addSearchField('Account.Name');","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"534f0f5d-84ab-4305-975c-8f38886a0f35"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"fieldName","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"The API name of a field that you want to be searched.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setLabelTemplate","type":"text"}]},{"type":"codeBlock","content":[{"text":"void setLabelTemplate(String template, List mergeFields)","type":"text"}]},{"type":"paragraph","content":[{"text":"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: ","type":"text"},{"text":"LastName, FirstName (AccountName)","type":"text","marks":[{"type":"em"}]},{"text":", you would do the following:","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.setLabelTemplate('{0}, {1} ({2})', new List{'LastName', 'FirstName', 'Account.Name'});","type":"text"}]},{"type":"paragraph","content":[{"text":"The above would result in an output like this:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":263,"id":"84fabe7c-2e3e-4851-8e4e-951ef7fb994d","collection":"contentId-1885437966","type":"file","height":157}}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"If the user performing the search has no access to any of these fields, they are replaced with an empty string. ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.setLabelTemplate('{0}', new List{'Name'});","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"04b2f7be-6b72-4c6b-aff6-e156970d8aec"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"template","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"A string containing numbered placeholders which will be replaced with actual values in the final result.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"mergeFields","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"List","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"An ordered list of merge field API names. These will replace the matching placeholders in the template with each record’s actual values.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setMetaTemplate","type":"text"}]},{"type":"codeBlock","content":[{"text":"void setMetaTemplate(String template, List mergeFields)","type":"text"}]},{"type":"paragraph","content":[{"text":"Similar to the above method ","type":"text"},{"text":"setLabelTemplate","type":"text","marks":[{"type":"code"}]},{"text":", 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:","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.setMetaTemplate('Mobile: {0}', new List{'MobilePhone'});","type":"text"}]},{"type":"paragraph","content":[{"text":"The above would result in an output like this:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":207,"id":"3dd8b0a8-7fe9-4c29-b5ed-0e097ae62626","collection":"contentId-1885437966","type":"file","height":184}}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"If the user performing the search has no access to any of these fields, they are replaced with an empty string. ","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"f35d1984-e448-411e-8928-49e424c4b2b4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"template","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"A string containing numbered placeholders which will be replaced with actual values in the final result.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"mergeFields","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"List","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"An ordered list of merge field API names. These will replace the matching placeholders in the template with each record’s actual values.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setDefaultIcon","type":"text"}]},{"type":"codeBlock","content":[{"text":"void setDefaultIcon(String icon)","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets the icons for the results generated through this context. You can use icons from this page: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://www.lightningdesignsystem.com/icons/"}},{"text":" , 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.","type":"text"}]},{"type":"paragraph","content":[{"text":"Return value:","type":"text","marks":[{"type":"strong"}]},{"text":" B25.SearchResult","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.setDefaultIcon('utility:activity')","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"e4af0357-8983-425d-8457-72aa517157f3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"icon","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[226.67]},"content":[{"type":"paragraph","content":[{"text":"The name of the icon.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setOrderBy","type":"text"}]},{"type":"codeBlock","content":[{"text":"void setOrderBy(String orderField, String sortOrder)","type":"text"}]},{"type":"paragraph","content":[{"text":"Used to override the sorting mechanism for the results generated through this context. ","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, ","type":"text"},{"text":"searchContext.setOrderBy('Email', 'ASC NULLS LAST')","type":"text","marks":[{"type":"code"}]},{"text":" will alphabetically sort the returned records by the ","type":"text"},{"text":"Email","type":"text","marks":[{"type":"code"}]},{"text":" field on the object, with the records that contain no email address put at the bottom.","type":"text"}]},{"type":"paragraph","content":[{"text":"Possible values for sort order include:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASC NULLS FIRST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASC NULLS LAST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASC","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DESC NULLS FIRST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DESC NULLS LAST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DESC","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Return value:","type":"text","marks":[{"type":"strong"}]},{"text":" B25.SearchResult","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.setOrderBy('Email', 'ASC NULLS LAST')","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"0a0e0802-6bb0-4b68-9bec-fdd25e9f407b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"orderField","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The field name that will be used to sort the results.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"sortOrder","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"String","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The sorting clause that will be applied to the results.","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"setOrderBy","type":"text"}]},{"type":"codeBlock","content":[{"text":"void setOrderBy(List orderFields, List sortOrders)","type":"text"}]},{"type":"paragraph","content":[{"text":"Used to override the sorting mechanism for the results generated through this context. Results will be ordered by the entries in ","type":"text"},{"text":"orderFields","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"sortOrder","type":"text","marks":[{"type":"code"}]},{"text":", starting with the first in each of the two lists.","type":"text"}]},{"type":"paragraph","content":[{"text":"Take the following example: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"List orderFields = new List{'FirstName', 'LastName'};\nList sortOrders = new List{'ASC NULLS LAST', 'DESC'};\n\nsearchContext.setOrderBy(orderFields, sortOrders);","type":"text"}]},{"type":"paragraph","content":[{"text":"This will alphabetically sort the returned records by the ","type":"text"},{"text":"FirstName","type":"text","marks":[{"type":"code"}]},{"text":" field on the object, with the records that contain no ","type":"text"},{"text":"FirstName","type":"text","marks":[{"type":"code"}]},{"text":" put at the bottom.","type":"text"}]},{"type":"paragraph","content":[{"text":"Then, for each record with a duplicate ","type":"text"},{"text":"FirstName","type":"text","marks":[{"type":"code"}]},{"text":", the records will be ordered by how recently they were created.","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that the number of ordering fields must match the number of sort order clauses provided.","type":"text"}]},{"type":"paragraph","content":[{"text":"Possible values for sort order include:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASC NULLS FIRST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASC NULLS LAST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ASC","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DESC NULLS FIRST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DESC NULLS LAST","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DESC","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Return value:","type":"text","marks":[{"type":"strong"}]},{"text":" B25.SearchResult","type":"text"}]},{"type":"codeBlock","content":[{"text":"searchContext.setOrderBy(new List{'FirstName', 'LastName'}, new List{'ASC NULLS LAST', 'DESC'})","type":"text"}]},{"type":"paragraph","content":[{"text":"Parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"0613ea9e-f1d7-4a21-b6d9-ae00bee084c6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"orderFields","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"List","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The field names that will be used to sort the results.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"sortOrders","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"List","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The sorting clauses that will be applied to the results.","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported