Interface: ISearchContext¶
The object used by DataQueryBuilder to make OData query
Hierarchy¶
- ISearchContext
Summary¶
Properties¶
Class Properties¶
- caseSensitive
- filter
- numberSearchConversionMethod
- orderBy
- searchKeys
- service
- serviceName
- useSearchOverFilterEnabled
Inherited Properties¶
Currently none inherited from the parent class(es).
Properties¶
Optional
caseSensitive¶
• caseSensitive? : boolean
A boolean to define whether the search is case-sensitive. Only applicable to Offline OData.
Optional
filter¶
• 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¶
• numberSearchConversionMethod? : ConversionMethod
A string to determine whether the conversion method that will be used for number search. Only applicable to Online OData.
Optional
orderBy¶
• orderBy? : string
A string to define the orderBy section for the Odata query. It should look like "OrderId asc" or "ShortDescription desc"
Optional
searchKeys¶
• searchKeys? : string[]
A string list to define which keys will be used for searching. Only those valid keys will be included
Optional
service¶
• service? : ITargetServiceSpecifier
An object to define the service and related options
Optional
serviceName¶
• serviceName? : string
A string to define the path to the service file
Optional
useSearchOverFilterEnabled¶
• useSearchOverFilterEnabled? : boolean