Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NumberFilterFunction<EntityT>

Representation of a filter function, that has returns a value of type number. This supports int, double and decimal values.

Type parameters

Hierarchy

Index

Constructors

constructor

  • Creates an instance of NumberFilterFunction.

    Parameters

    • functionName: string

      Name of the function that returns a numeric value

    • parameters: Array<FilterFunctionParameterType<EntityT>>

      Representation of the parameters passed to the filter function

    • edmType: "Edm.Int32" | "Edm.Double" | "Edm.Decimal"

      Type of the returned numeric value. This influences the formatting of the returned value.

    Returns NumberFilterFunction

Properties

edmType

edmType: EdmType

EdmType of the return type of the filter function.

functionName

functionName: string

Name of the function

parameters

parameters: Array<FilterFunctionParameterType<EntityT>>

Representation of the parameters passed to the filter function

Methods

equals

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

    Parameters

    • value: number

      Value to be used in the filter

    Returns Filter<EntityT, number>

    The resulting filter

greaterOrEqual

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

    Parameters

    • value: number

      Value to be used in the filter

    Returns Filter<EntityT, number>

    The resulting filter

greaterThan

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

    Parameters

    • value: number

      Value to be used in the filter

    Returns Filter<EntityT, number>

    The resulting filter

lessOrEqual

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

    Parameters

    • value: number

      Value to be used in the filter

    Returns Filter<EntityT, number>

    The resulting filter

lessThan

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

    Parameters

    • value: number

      Value to be used in the filter

    Returns Filter<EntityT, number>

    The resulting filter

notEquals

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

    Parameters

    • value: number

      Value to be used in the filter

    Returns Filter<EntityT, number>

    The resulting filter

toString

  • toString(parentFieldNames?: string[]): string
  • Serializes the filter function into a string

    Parameters

    • Default value parentFieldNames: string[] = []

      Names of parents in case the function is part of a filter on a navigation property

    Returns string

    The filter function as string