Options
All
  • Public
  • Public/Protected
  • All
Menu

Data structure to represent filter on properties of a navigation property (link). In OData v2 filtering for navigation properties is ONLY supported for properties with a one-to-one cardinality ({OneToOneLink}).

Example: In the following filter statement Entity.requestBuilder().filter(Entity.to_NavProperty.filter(LinkedEntity.property.equals(value))), Entity.to_NavProperty.filter(LinkedEntity.property.equals(value)) is a FilterLink.

In OData v4 filtering is also possible on one to many links. See OneToManyLink.

Type parameters

  • EntityT: EntityBase

    Type of the entity to be filtered

  • LinkedEntityT: EntityBase = any

    Type of the linked entity which is used in the filter

Hierarchy

  • FilterLink

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

constructor

  • new FilterLink<EntityT, LinkedEntityT>(link: Link<EntityT, LinkedEntityT>, filters: Filterable<LinkedEntityT>[]): FilterLink<EntityT, LinkedEntityT>
  • Creates an instance of FilterLink.

    Type parameters

    Parameters

    • link: Link<EntityT, LinkedEntityT>

      Linked entity to be used in the filter

    • filters: Filterable<LinkedEntityT>[]

      List of filterables for the linked entity

    Returns FilterLink<EntityT, LinkedEntityT>

Properties

Readonly _entity

_entity: EntityT

Entity type of the entity tp be filtered.

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Constructor type of the entity to be filtered.

Readonly _linkedEntityType

_linkedEntityType: LinkedEntityT

Linked entity to be filtered by.

filters

filters: Filterable<LinkedEntityT>[]

link

link: Link<EntityT, LinkedEntityT>