Class Link<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a navigation property of an OData entity.

OData is a relational data model, i.e. entities can be related to one another. For example, BusinessPartner is in a 1:n relation with BusinessPartnerAddress and in a 1:1 relation with Customer. Like normal properties, navigation properties can be used for selecting (expanding) and filtering. For example, when constructing a query on the BusinessPartner entity, an instance of Link<BusinessPartner, Customer> can be passed as argument to the select function, e.g. BusinessPartner.TO_CUSTOMER.

NOTE: Due to historical development the Link and its extensions are used in the following way: OData v2 entity: 1:N is a Link, 1:0..1 is a OneToOneLink OData v4 entity: 1:N is a OneToManyLink, 1:0..1 is a OneToOneLink.

See also: Selectable.

Type of the entity to be linked to.

Type Parameters

Hierarchy (View Summary)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

Methods

  • Create a new link based on a given link.

    Returns this

    Newly created link.