Interface: ISearchContext¶

The object used by DataQueryBuilder to make OData query

Summary¶

Currently none inherited from the parent class(es).

Currently none in this class.

Currently none inherited from the parent class(es).

optional caseSensitive?: boolean

A boolean to define whether the search is case-sensitive. Only applicable to Offline OData.

optional filter?: string

A string to define the filter to be used in the $filter section for the Odata query. It should look like "OrderId eq '4001234'"

optional numberSearchConversionMethod?: "NoConversion" | "UseCast" | "UseConcat"

A string to determine whether the conversion method that will be used for number search. Only applicable to Online OData.

optional orderBy?: string

A string to define the orderBy section for the Odata query. It should look like "OrderId asc" or "ShortDescription desc"

optional searchKeys?: string[]

A string list to define which keys will be used for searching. Only those valid keys will be included

optional service?: ITargetServiceSpecifier

An object to define the service and related options

optional serviceName?: string

A string to define the path to the service file

optional useSearchOverFilterEnabled?: boolean