Class OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

constructor

• new OneToManyLink<
      EntityT extends EntityBase,
      DeSerializersT extends
          DeSerializers<
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
              any,
          >,
      LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT>,
  >(
      _fieldName: string,
      _entityApi: EntityApi<EntityT, DeSerializersT>,
      _linkedEntityApi: LinkedEntityApiT,
  ): OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

• Creates an instance of Link.

  Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers<
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
        any,
    >
  • LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT>

  Parameters

  • _fieldName: string

    Name of the linking field to be used in the OData request.
  • _entityApi: EntityApi<EntityT, DeSerializersT>

    Entity API for building and executing the request.
  • _linkedEntityApi: LinkedEntityApiT

    Constructor of the linked entity.

  Returns OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

_filters

_orderBy

_skip

_top

clone

• clone(): this

• Create a new link based on a given link.

  Returns this

  Newly created link.

filter

• filter(
      ...expressions: (
          | Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>
          | OneToManyLink<
              EntityType<LinkedEntityApiT>,
              DeSerializersT,
              EntityApi<EntityBase, DeSerializersT>,
          >
      )[],
  ): this

• Create filter statements to be applied to the OData request based on the linked entity values.

  Parameters

  • ...expressions: (
        | Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>
        | OneToManyLink<
            EntityType<LinkedEntityApiT>,
            DeSerializersT,
            EntityApi<EntityBase, DeSerializersT>,
        >
    )[]

    Filters based on the linked entity.

  Returns this

  Newly created FilterLink.

orderBy

• orderBy(...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]): this

• Add order-by statements to the request.

  Parameters

  • ...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]

    OrderBy statements to order the response by.

  Returns this

  The request builder itself, to facilitate method chaining.

skip

• skip(skip: number): this

• Skip number of entities.

  Parameters

  • skip: number

    Number of matching entities to skip. Useful for paging.

  Returns this

  The request builder itself, to facilitate method chaining.

top

• top(top: number): this

• Number of returned entities.

  Parameters

  • top: number

    Maximum number of entities to return in the response. Can be less, if less entities match the request.

  Returns this

  The request builder itself, to facilitate method chaining.

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