Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilterParams

Data transfer object used to pass filter parameters as simple key-value pairs.

see

StringValueMap

Example

let filter = FilterParams.fromTuples(
    "type", "Type1",
    "from_create_time", new Date(2000, 0, 1),
    "to_create_time", new Date(),
    "completed", true
);
let paging = new PagingParams(0, 100);

myDataClient.getDataByFilter(filter, paging, (err, page) => {...});

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

append

  • append(map: any): void

clear

  • clear(): any

clone

  • clone(): any

get

  • get(key: string): string

  • Gets a map element specified by its key.

    Parameters

    • key: string

      a key of the element to get.

    Returns string

    the value of the map element.

getAsArray

getAsArrayWithDefault

getAsBoolean

  • getAsBoolean(key: string): boolean

getAsBooleanWithDefault

  • getAsBooleanWithDefault(key: string, defaultValue: boolean): boolean

getAsDateTime

  • getAsDateTime(key: string): Date

getAsDateTimeWithDefault

  • getAsDateTimeWithDefault(key: string, defaultValue: Date): Date

getAsDouble

  • getAsDouble(key: string): number

getAsDoubleWithDefault

  • getAsDoubleWithDefault(key: string, defaultValue: number): number

getAsFloat

  • getAsFloat(key: string): number

getAsFloatWithDefault

  • getAsFloatWithDefault(key: string, defaultValue: number): number

getAsInteger

  • getAsInteger(key: string): number

getAsIntegerWithDefault

  • getAsIntegerWithDefault(key: string, defaultValue: number): number

getAsLong

  • getAsLong(key: string): number

getAsLongWithDefault

  • getAsLongWithDefault(key: string, defaultValue: number): number

getAsMap

  • Converts map element into an AnyValueMap or returns empty AnyValueMap if conversion is not possible.

    see

    fromValue

    Parameters

    • key: string

      a key of element to get.

    Returns AnyValueMap

    AnyValueMap value of the element or empty AnyValueMap if conversion is not supported.

getAsMapWithDefault

getAsNullableArray

getAsNullableBoolean

  • getAsNullableBoolean(key: string): boolean

getAsNullableDateTime

  • getAsNullableDateTime(key: string): Date

getAsNullableDouble

  • getAsNullableDouble(key: string): number

getAsNullableFloat

  • getAsNullableFloat(key: string): number

getAsNullableInteger

  • getAsNullableInteger(key: string): number

getAsNullableLong

  • getAsNullableLong(key: string): number

getAsNullableMap

getAsNullableString

  • getAsNullableString(key: string): string

getAsNullableType

  • getAsNullableType<T>(type: TypeCode, key: string): T

getAsObject

  • getAsObject(key?: string): any

  • Gets the value stored in map element without any conversions. When element key is not defined it returns the entire map value.

    Parameters

    • Default value key: string = undefined

      (optional) a key of the element to get

    Returns any

    the element value or value of the map when index is not defined.

getAsString

  • getAsString(key: string): string

getAsStringWithDefault

  • getAsStringWithDefault(key: string, defaultValue: string): string

getAsType

  • getAsType<T>(type: TypeCode, key: string): T

  • Converts map element into a value defined by specied typecode. If conversion is not possible it returns default value for the specified type.

    see

    getAsTypeWithDefault

    Type parameters

    • T

    Parameters

    • type: TypeCode

      the TypeCode that defined the type of the result

    • key: string

      a key of element to get.

    Returns T

    element value defined by the typecode or default if conversion is not supported.

getAsTypeWithDefault

  • getAsTypeWithDefault<T>(type: TypeCode, key: string, defaultValue: T): T

  • Converts map element into a value defined by specied typecode. If conversion is not possible it returns default value.

    see

    TypeConverter.toTypeWithDefault

    Type parameters

    • T

    Parameters

    • type: TypeCode

      the TypeCode that defined the type of the result

    • key: string

      a key of element to get.

    • defaultValue: T

      the default value

    Returns T

    element value defined by the typecode or default value if conversion is not supported.

getAsValue

getKeys

  • getKeys(): string[]

length

  • length(): number

put

  • put(key: string, value: any): any

  • Puts a new value into map element specified by its key.

    Parameters

    • key: string

      a key of the element to put.

    • value: any

      a new value for map element.

    Returns any

remove

  • remove(key: string): void

setAsObject

  • setAsObject(key: any, value?: any): void

  • Sets a new value to map element specified by its index. When the index is not defined, it resets the entire map value. This method has double purpose because method overrides are not supported in JavaScript.

    see

    MapConverter.toMap

    Parameters

    • key: any

      (optional) a key of the element to set

    • Default value value: any = undefined

      a new element or map value.

    Returns void

toString

  • toString(): string

  • Gets a string representation of the object. The result is a semicolon-separated list of key-value pairs as "key1=value1;key2=value2;key=value3"

    Returns string

    a string representation of the object.

Static fromMaps

  • Creates a new AnyValueMap by merging two or more maps. Maps defined later in the list override values from previously defined maps.

    Parameters

    • Rest ...maps: any[]

      an array of maps to be merged

    Returns StringValueMap

    a newly created AnyValueMap.

Static fromString

Static fromTuples

  • Creates a new FilterParams from a list of key-value pairs called tuples.

    Parameters

    • Rest ...tuples: any[]

      a list of values where odd elements are keys and the following even elements are values

    Returns FilterParams

    a newly created FilterParams.

Static fromTuplesArray

  • Creates a new StringValueMap from a list of key-value pairs called tuples. The method is similar to fromTuples but tuples are passed as array instead of parameters.

    Parameters

    • tuples: any[]

      a list of values where odd elements are keys and the following even elements are values

    Returns StringValueMap

    a newly created StringValueMap.

Static fromValue

Generated using TypeDoc