kotlin-odata/com.sap.cloud.mobile.kotlin.odata/StructureBase/getSearchWords

getSearchWords

open fun getSearchWords(): StringList

See getSearchWords(PropertyList?, Boolean).

Return

(see linked method).

open fun getSearchWords(select: PropertyList?): StringList

See getSearchWords(PropertyList?, Boolean).

Return

(see linked method).

Parameters

select

Select parameter.

open fun getSearchWords(select: PropertyList?, tabs: Boolean): StringList

Return the candidate search words in this structure, for use by {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression#matches(com.sap.cloud.mobile.kotlin.odata.StringList) SearchExpression.matches}. Search words are obtained from string-typed properties using {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression#wordsInText(kotlin.String) SearchExpression.wordsInText}.

Return

The candidate search words in this structure, for use by {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression#matches(com.sap.cloud.mobile.kotlin.odata.StringList) SearchExpression.matches}.

Parameters

select

(nullable) Selected list of properties (can refer to properties of nested structure types). If null, then all string-typed properties will be selected.

tabs

Should a tab be added between the words for separate properties, to prevent {@link com.sap.cloud.mobile.kotlin.odata.SearchTerm#phrase(com.sap.cloud.mobile.kotlin.odata.StringList) SearchTerm.phrase} searches from matching phrases with words from different properties. Defaults to true.