Class CollectionFilterFunction<EntityT, FieldT>

Representation of a filter function, that returns a collection of values.

Type Parameters

EntityT extends EntityBase
FieldT

Hierarchy (View Summary, Expand)

FilterFunction<EntityT, FieldT[]>
- CollectionFilterFunction

Index

Constructors

Properties

edmType functionName parameters

Methods

equals notEquals

Constructors

constructor

new CollectionFilterFunction<EntityT extends EntityBase, FieldT>(
    functionName: string,
    parameters: FilterFunctionParameterType<EntityT>[],
    edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4,
): CollectionFilterFunction<EntityT, FieldT>
Creates an instance of CollectionFilterFunction.
Type Parameters
- EntityT extends EntityBase
- FieldT
Parameters
- functionName: string
  Name of the function that returns a collection value.
- parameters: FilterFunctionParameterType<EntityT>[]
  Representation of the parameters passed to the filter function.
- edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
  Type of the returned collection value. This influences the formatting of the returned value.
Returns CollectionFilterFunction<EntityT, FieldT>
Overrides FilterFunction.constructor
- Defined in packages/odata-common/dist/filter/collection-filter-function.d.ts:15

Properties

`Readonly`edmType

edmType: EdmTypeShared<ODataVersionOf<EntityT>>

`Readonly`functionName

functionName: string

`Readonly`parameters

parameters: FilterFunctionParameterType<EntityT>[]

Methods

equals

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

notEquals

notEquals(value: FieldT[]): Filter<EntityT, any, FieldT[]>
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.
Parameters
- value: FieldT[]
  Value to be used in the filter.
Returns Filter<EntityT, any, FieldT[]>
The resulting filter.

Copyright Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.
Inherited from FilterFunction.notEquals
- Defined in packages/odata-common/dist/filter/filter-function-base.d.ts:32