Class FilterFunction<EntityT, ReturnT> Abstract

Data structure to represent OData filter functions. Use the factory function filterFunction to create instances of FilterFunction.

Type parameters

EntityT: EntityBase
ReturnT: FieldType | FieldType[]

Hierarchy

FilterFunction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FilterFunction<EntityT, ReturnT>(functionName: string, parameters: FilterFunctionParameterType<EntityT>[], edmType: EdmTypeShared<ODataVersionOf<EntityT>>): FilterFunction<EntityT, ReturnT>

- Defined in packages/core/dist/odata-common/filter/filter-function-base.d.ts:20
Creates an instance of FilterFunction.

Type parameters
- EntityT: EntityBase<EntityT>
- ReturnT: FieldType | FieldType[]
Parameters
- functionName: string
  
  Name of the function.
- parameters: FilterFunctionParameterType<EntityT>[]
  
  Representation of the parameters passed to the filter function.
- edmType: EdmTypeShared<ODataVersionOf<EntityT>>
  
  EDM type of the return type of the filter function.
Returns FilterFunction<EntityT, ReturnT>

Properties

Readonly edmType

edmType: EdmTypeShared<ODataVersionOf<EntityT>>

Readonly functionName

functionName: string

Readonly parameters

parameters: FilterFunctionParameterType<EntityT>[]

Methods

equals

equals(value: ReturnT): Filter<EntityT, ReturnT>

- Defined in packages/core/dist/odata-common/filter/filter-function-base.d.ts:34
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

Parameters
- value: ReturnT
  
  Value to be used in the filter
Returns Filter<EntityT, ReturnT>
The resulting filter

notEquals

notEquals(value: ReturnT): Filter<EntityT, ReturnT>

- Defined in packages/core/dist/odata-common/filter/filter-function-base.d.ts:41
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

Parameters
- value: ReturnT
  
  Value to be used in the filter
Returns Filter<EntityT, ReturnT>
The resulting filter

toString

toString(parentFieldNames?: string[]): string

- Defined in packages/core/dist/odata-common/filter/filter-function-base.d.ts:27
deprecated
Since v1.21.0. There will be no replacement. Let us know if you were using this functionality. Serializes the filter function into a string

Parameters
- Optional parentFieldNames: string[]
  
  Names of parents in case the function is part of a filter on a navigation property
Returns string
The filter function as string

Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.