Options
All
  • Public
  • Public/Protected
  • All
Menu
deprecated

Since v1.47.0. Use OrderableEdmTypeField instead. Represents a complex type property with a time value.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

  • ComplexT = any

Hierarchy

Index

Constructors

constructor

  • Creates an instance of ComplexTypeTimePropertyField.

    Type parameters

    Parameters

    • fieldName: string

      Actual name of the field used in the OData request

    • fieldOf: ConstructorOrField<EntityT, ComplexT>

      The constructor of the entity or the complex type this field belongs to

    • edmType: EdmTypeShared<ODataVersionOf<EntityT>>

      Type of the field according to the metadata description

    Returns ComplexTypeTimePropertyField<EntityT, ComplexT>

  • Creates an instance of ComplexTypeTimePropertyField.

    deprecated

    Since v1.19.0.

    Creates an instance of ComplexTypeTimePropertyField.

    Type parameters

    Parameters

    • fieldName: string

      Actual name of the field used in the OData request

    • entityConstructor: Constructable<EntityT, unknown>

      Constructor type of the entity the field belongs to

    • parentTypeName: string

      Name of the parent complex type

    • edmType: EdmTypeShared<ODataVersionOf<EntityT>>

      Type of the field according to the metadata description

    Returns ComplexTypeTimePropertyField<EntityT, ComplexT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly _fieldOf

_fieldOf: ConstructorOrField<EntityT, any>

Readonly _fieldOptions

_fieldOptions: Required<FieldOptions<false, false>>

Readonly edmType

Readonly fieldOf

fieldOf: ConstructorOrField<EntityT, ComplexT>

The constructor of the entity or the complex type this field belongs to

Methods

equals

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

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

fieldPath

  • fieldPath(): string
  • Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.

    Returns string

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

greaterOrEqual

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

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

greaterThan

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

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

lessOrEqual

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

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

lessThan

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

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter

notEquals

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

    Parameters

    • value: Time

      Value to be used in the filter

    Returns Filter<EntityT, Time>

    The resulting filter