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

EdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.

Type Parameters

EntityT extends EntityBase
Type of the entity the field belongs to.
DeSerializersT extends DeSerializers
EdmT extends EdmTypeShared<"any">
EDM type of the field.
NullableT extends boolean = false
Boolean type that represents whether the field is nullable.
SelectableT extends boolean = false
Boolean type that represents whether the field is selectable.

Hierarchy (View Summary)

EdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>
- OrderableEdmTypeField

Index

Constructors

constructor

new OrderableEdmTypeField<
    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,
>(
    fieldName: string,
    _fieldOf: ConstructorOrField<EntityT>,
    edmType: EdmT,
    _deSerializers: DeSerializersT,
    fieldOptions?: FieldOptions<NullableT, SelectableT>,
): 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.
- OptionalfieldOptions: FieldOptions<NullableT, SelectableT>
  Optional settings for this field.
Returns OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>
Inherited from EdmTypeField.constructor
- Defined in packages/odata-common/dist/selectable/edm-type-field.d.ts:49

Properties

_deSerializers

_deSerializers: DeSerializersT

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

`Readonly`_entity

_entity: EntityT

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

`Readonly`_entityConstructor

_entityConstructor: Constructable<EntityT>

`Readonly`_fieldName

_fieldName: string

`Readonly`_fieldOf

_fieldOf: ConstructorOrField<EntityT>

`Readonly`_fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

`Readonly`edmType

edmType: EdmT

Methods

equals

equals(
    value: NullableFieldType<
        DeserializedType<DeSerializersT, EdmT>,
        NullableT,
    >,
): 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.
Inherited from EdmTypeField.equals
- Defined in packages/odata-common/dist/selectable/edm-type-field.d.ts:56

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.
Inherited from EdmTypeField.fieldPath
- Defined in packages/odata-common/dist/selectable/edm-type-field.d.ts:67

greaterOrEqual

greaterOrEqual(
    value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
): Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. >=.
Parameters
- value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>
  Value to be used in the filter.
Returns Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
The resulting filter.
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:26

greaterThan

greaterThan(
    value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
): Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. >.
Parameters
- value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>
  Value to be used in the filter.
Returns Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
The resulting filter.
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:20

lessOrEqual

lessOrEqual(
    value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
): Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
Creates an instance of Filter for this field and the given value using the operator 'le', i.e. <=.
Parameters
- value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>
  Value to be used in the filter.
Returns Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
The resulting filter.
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:38

lessThan

lessThan(
    value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
): Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. <.
Parameters
- value: FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>
  Value to be used in the filter.
Returns Filter<
    EntityT,
    DeSerializersT,
    FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>
The resulting filter.
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:32

notEquals

notEquals(
    value: NullableFieldType<
        DeserializedType<DeSerializersT, EdmT>,
        NullableT,
    >,
): 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.
Inherited from EdmTypeField.notEquals
- Defined in packages/odata-common/dist/selectable/edm-type-field.d.ts:62

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

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

_deSerializers

Readonly_entity

Readonly_entityConstructor

Readonly_fieldName

Readonly_fieldOf

Readonly_fieldOptions

ReadonlyedmType

Methods

equals

Parameters

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

fieldPath

Returns string

greaterOrEqual

Parameters

Returns Filter< EntityT, DeSerializersT, FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,>

greaterThan

Parameters

Returns Filter< EntityT, DeSerializersT, FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,>

lessOrEqual

Parameters

Returns Filter< EntityT, DeSerializersT, FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,>

lessThan

Parameters

Returns Filter< EntityT, DeSerializersT, FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,>

notEquals

Parameters

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

Settings

On This Page

`Readonly`_entity

`Readonly`_entityConstructor

`Readonly`_fieldName

`Readonly`_fieldOf

`Readonly`_fieldOptions

`Readonly`edmType

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

Returns Filter<
EntityT,
DeSerializersT,
FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>

Returns Filter<
EntityT,
DeSerializersT,
FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>

Returns Filter<
EntityT,
DeSerializersT,
FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>

Returns Filter<
EntityT,
DeSerializersT,
FieldTypeByEdmType<DeSerializersT, EdmT, NullableT>,
>

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