Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a complex type property with a date value.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

  • ComplexT = any

Hierarchy

Index

Constructors

constructor

  • Creates an instance of ComplexTypeDatePropertyField.

    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<VersionT>

      Type of the field according to the metadata description

    Returns ComplexTypeDatePropertyField<EntityT, ComplexT>

  • deprecated

    Since v1.19.0.

    Creates an instance of ComplexTypeDatePropertyField.

    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<VersionT>

      Type of the field according to the metadata description

    Returns ComplexTypeDatePropertyField<EntityT, ComplexT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly edmType

edmType: EdmTypeShared<VersionT>

Readonly fieldOf

fieldOf: ConstructorOrField<EntityT, ComplexT>

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

Methods

equals

  • equals(value: Moment): Filter<EntityT, Moment>
  • Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: Moment

      Value to be used in the filter

    Returns Filter<EntityT, Moment>

    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

  • greaterOrEqual(value: Moment): Filter<EntityT, Moment>
  • Creates an instance of Filter for this field and the given value using the operator 'ge', i.e. >=.

    Parameters

    • value: Moment

      Value to be used in the filter

    Returns Filter<EntityT, Moment>

    The resulting filter

greaterThan

  • greaterThan(value: Moment): Filter<EntityT, Moment>
  • Creates an instance of Filter for this field and the given value using the operator 'gt', i.e. >.

    Parameters

    • value: Moment

      Value to be used in the filter

    Returns Filter<EntityT, Moment>

    The resulting filter

lessOrEqual

  • lessOrEqual(value: Moment): Filter<EntityT, Moment>
  • Creates an instance of Filter for this field and the given value using the operator 'le', i.e. <=.

    Parameters

    • value: Moment

      Value to be used in the filter

    Returns Filter<EntityT, Moment>

    The resulting filter

lessThan

  • lessThan(value: Moment): Filter<EntityT, Moment>
  • Creates an instance of Filter for this field and the given value using the operator 'lt', i.e. <.

    Parameters

    • value: Moment

      Value to be used in the filter

    Returns Filter<EntityT, Moment>

    The resulting filter

notEquals

  • notEquals(value: Moment): Filter<EntityT, Moment>
  • Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: Moment

      Value to be used in the filter

    Returns Filter<EntityT, Moment>

    The resulting filter