Class OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>

constructor

• new OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>(fieldName, _fieldOf, edmType, _deSerializers, fieldOptions?): OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>

• Creates an instance of EdmTypeField.

  Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>
  • EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
  • NullableT extends boolean = false
  • SelectableT extends boolean = false

  Parameters

  • fieldName: string

    Actual name of the field used in the OData request.
  • _fieldOf: ConstructorOrField<EntityT>

    Constructor type of the entity the field belongs to.
  • edmType: EdmT

    Type of the field according to the metadata description.
  • _deSerializers: DeSerializersT

    (De-)serializers used for transformation.
  • Optional fieldOptions: FieldOptions<NullableT, SelectableT>

    Optional settings for this field.

  Returns OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>

_deSerializers

Readonly _entity

Readonly _entityConstructor

Readonly _fieldName

Readonly _fieldOf

Readonly _fieldOptions

Readonly edmType

equals

• equals(value): Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>

• Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

  Parameters

  • value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>

    Value to be used in the filter.

  Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>

  The resulting filter.

fieldPath

• fieldPath(): string

• Path to the field to be used in filter and order by queries.

  Returns string

  Path to the field to be used in filter and order by queries.

notEquals

• notEquals(value): Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>

• Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

  Parameters

  • value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>

    Value to be used in the filter.

  Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>

  The resulting filter.

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