Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a property with a time value.

Type parameters

  • EntityT: EntityBase

    Type of the entity the field belongs to

Hierarchy

Index

Constructors

constructor

  • new TimeFieldBase<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT, unknown>, edmType: EdmTypeShared<VersionT>): TimeFieldBase<EntityT>
  • Creates an instance of EdmTypeField.

    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

    • edmType: EdmTypeShared<VersionT>

      Type of the field according to the metadata description

    Returns TimeFieldBase<EntityT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly edmType

edmType: EdmTypeShared<VersionT>

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. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.

    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