Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OneToManyLink<EntityT, LinkedEntityT>

Represents a one to many relation for OData v4 entites. For OData v2 entites the Link is used to represent one to many relation.

See also Link for more informations.

Type parameters

Hierarchy

  • Link<EntityT, LinkedEntityT>
    • OneToManyLink

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

constructor

  • new OneToManyLink(_fieldName: string, _entityConstructor: Constructable<EntityT>, _linkedEntity: Constructable<LinkedEntityT>): OneToManyLink
  • Creates an instance of Link.

    Parameters

    • _fieldName: string

      Name of the linking field to be used in the OData request.

    • _entityConstructor: Constructable<EntityT>

      Constructor type of the entity the field belongs to

    • _linkedEntity: Constructable<LinkedEntityT>

      Constructor type of the linked entity

    Returns OneToManyLink

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT>

Constructor type of the entity the field belongs to

_expand

_expand: Expandable<LinkedEntityT>[] = []

Readonly _fieldName

_fieldName: string

Name of the linking field to be used in the OData request.

_filters

_filters: FilterLink<EntityT, LinkedEntityT>

Readonly _linkedEntity

_linkedEntity: Constructable<LinkedEntityT>

Constructor type of the linked entity

_orderBy

_orderBy: Orderable<LinkedEntityT>[] = []

_selects

_selects: Selectable<LinkedEntityT>[] = []

List of selectables on the linked entity.

_skip

_skip: number

_top

_top: number

Accessors

selects

Methods

clone

  • clone(): this

expand

  • expand(...expands: Expandable<LinkedEntityT>[]): this

filter

orderBy

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

select

  • select(...selects: Selectable<LinkedEntityT>[]): this

skip

  • skip(skip: number): this

top

  • top(top: number): this
  • Limit 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

Static clone

  • clone<EntityT1, LinkedEntityT1>(link: Link<EntityT1, LinkedEntityT1>): Link<EntityT1, LinkedEntityT1>