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

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

Index

Constructors

constructor

new OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>(fieldName: string, _fieldOf: ConstructorOrField<EntityT, any>, edmType: EdmT, _deSerializers: DeSerializersT, fieldOptions?: FieldOptions<NullableT, SelectableT>): OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>
Creates an instance of EdmTypeField.
Type Parameters
- EntityT extends EntityBase<EntityT>
- DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>
- 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, any>
  
  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>
Inherited from EdmTypeField.constructor
- Defined in packages/odata-common/dist/selectable/edm-type-field.d.ts:49

Properties

_deSerializers

_deSerializers: DeSerializersT

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

`Readonly` _entity

_entity: EntityT

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

`Readonly` _entityConstructor

_entityConstructor: Constructable<EntityT>

`Readonly` _fieldName

_fieldName: string

`Readonly` _fieldOf

_fieldOf: ConstructorOrField<EntityT, any>

`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. ==.

Returns
The resulting filter.
Parameters
- value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>
  
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>
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
Path to the field to be used in filter and order by queries.

Returns string
Inherited from EdmTypeField.fieldPath
- Defined in packages/odata-common/dist/selectable/edm-type-field.d.ts:67

greaterOrEqual

greaterOrEqual(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 'ge', i.e. >=.

Returns
The resulting filter.
Parameters
- value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>
  
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:25

greaterThan

greaterThan(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 'gt', i.e. >.

Returns
The resulting filter.
Parameters
- value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>
  
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:19

lessOrEqual

lessOrEqual(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 'le', i.e. <=.

Returns
The resulting filter.
Parameters
- value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>
  
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:37

lessThan

lessThan(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 'lt', i.e. <.

Returns
The resulting filter.
Parameters
- value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>
  
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>
- Defined in packages/odata-common/dist/selectable/orderable-edm-type-field.d.ts:31

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. !=.

Returns
The resulting filter.
Parameters
- value: NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>
  
  Value to be used in the filter.
Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>
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

EntityT extends EntityBase

DeSerializersT extends DeSerializers

EdmT extends EdmTypeShared<"any">

NullableT extends boolean = false

SelectableT extends boolean = false

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

EntityT extends EntityBase<EntityT>

DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, DeSerializersT>

EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

NullableT extends boolean = false

SelectableT extends boolean = false

Parameters

fieldName: string

_fieldOf: ConstructorOrField<EntityT, any>

edmType: EdmT

_deSerializers: DeSerializersT

Optional fieldOptions: FieldOptions<NullableT, SelectableT>

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

Properties

_deSerializers

Readonly _entity

Readonly _entityConstructor

Readonly _fieldName

Readonly _fieldOf

Readonly _fieldOptions

Readonly edmType

Methods

equals

Returns

Parameters

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

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

fieldPath

Returns

Returns string

greaterOrEqual

Returns

Parameters

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

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

greaterThan

Returns

Parameters

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

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

lessOrEqual

Returns

Parameters

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

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

lessThan

Returns

Parameters

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

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

notEquals

Returns

Parameters

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

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

Settings

Member Visibility

Theme

`Optional` fieldOptions: FieldOptions<NullableT, SelectableT>

`Readonly` _entity

`Readonly` _entityConstructor

`Readonly` _fieldName

`Readonly` _fieldOf

`Readonly` _fieldOptions

`Readonly` edmType