Class StringFilterFunction<EntityT>

Representation of a filter function, that returns a value of type string.

Type Parameters

EntityT extends EntityBase

Hierarchy

OrderableFilterFunction<EntityT, string>
- StringFilterFunction

Index

Constructors

Properties

edmType functionName parameters

Methods

equals greaterOrEqual greaterThan lessOrEqual lessThan notEquals

Constructors

constructor

new StringFilterFunction<EntityT extends EntityBase>(
functionName: string,
parameters: FilterFunctionParameterType<EntityT>[],
): StringFilterFunction<EntityT>
Creates an instance of StringFilterFunction.
Type Parameters
- EntityT extends EntityBase
Parameters
- functionName: string
  Name of the function that returns a string value.
- parameters: FilterFunctionParameterType<EntityT>[]
  Representation of the parameters passed to the filter function.
Returns StringFilterFunction<EntityT>
Overrides OrderableFilterFunction<EntityT, string>.constructor
- Defined in packages/odata-common/dist/filter/string-filter-function.d.ts:13

Properties

`Readonly`edmType

edmType: EdmTypeShared<ODataVersionOf<EntityT>>

`Readonly`functionName

functionName: string

`Readonly`parameters

parameters: FilterFunctionParameterType<EntityT>[]

Methods

equals

equals(value: string): Filter<EntityT, any, string>
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.
Parameters
- value: string
  Value to be used in the filter.
Returns Filter<EntityT, any, string>
The resulting filter.
Inherited from OrderableFilterFunction.equals
- Defined in packages/odata-common/dist/filter/filter-function-base.d.ts:26

greaterOrEqual

greaterOrEqual(value: string): Filter<EntityT, any, string>
Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.
Parameters
- value: string
  Value to be used in the filter.
Returns Filter<EntityT, any, string>
The resulting filter.
Inherited from OrderableFilterFunction.greaterOrEqual
- Defined in packages/odata-common/dist/filter/orderable-filter-function.d.ts:29

greaterThan

greaterThan(value: string): Filter<EntityT, any, string>
Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.
Parameters
- value: string
  Value to be used in the filter.
Returns Filter<EntityT, any, string>
The resulting filter.
Inherited from OrderableFilterFunction.greaterThan
- Defined in packages/odata-common/dist/filter/orderable-filter-function.d.ts:23

lessOrEqual

lessOrEqual(value: string): Filter<EntityT, any, string>
Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.
Parameters
- value: string
  Value to be used in the filter.
Returns Filter<EntityT, any, string>
The resulting filter.
Inherited from OrderableFilterFunction.lessOrEqual
- Defined in packages/odata-common/dist/filter/orderable-filter-function.d.ts:41

lessThan

lessThan(value: string): Filter<EntityT, any, string>
Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.
Parameters
- value: string
  Value to be used in the filter.
Returns Filter<EntityT, any, string>
The resulting filter.
Inherited from OrderableFilterFunction.lessThan
- Defined in packages/odata-common/dist/filter/orderable-filter-function.d.ts:35

notEquals

notEquals(value: string): Filter<EntityT, any, string>
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.
Parameters
- value: string
  Value to be used in the filter.
Returns Filter<EntityT, any, string>
The resulting filter.
Inherited from OrderableFilterFunction.notEquals
- Defined in packages/odata-common/dist/filter/filter-function-base.d.ts:32