Filter | Sage Intacct SDK for JavaScript

Hierarchy

Filter

Implements

IFilter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Filter(fieldName: string): Filter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:54
Parameters
- fieldName: string
Returns Filter

Properties

Private Readonly fieldName

fieldName: string

Private operation

operation: string

Private value

value: string | string[]

Static Readonly BETWEEN

BETWEEN: "between" = "between"

Static Readonly EQUAL_TO

EQUAL_TO: "equalto" = "equalto"

Static Readonly GREATER_THAN

GREATER_THAN: "greaterthan" = "greaterthan"

Static Readonly GREATER_THAN_OR_EQUAL_TO

GREATER_THAN_OR_EQUAL_TO: "greaterthanorequalto" = "greaterthanorequalto"

Static Readonly IN

IN: "in" = "in"

Static Readonly IS_NOT_NULL

IS_NOT_NULL: "isnotnull" = "isnotnull"

Static Readonly IS_NULL

IS_NULL: "isnull" = "isnull"

Static Readonly LESS_THAN

LESS_THAN: "lessthan" = "lessthan"

Static Readonly LESS_THAN_OR_EQUAL_TO

LESS_THAN_OR_EQUAL_TO: "lessthanorequalto" = "lessthanorequalto"

Static Readonly LIKE

LIKE: "like" = "like"

Static Readonly NOT_EQUAL_TO

NOT_EQUAL_TO: "notequalto" = "notequalto"

Static Readonly NOT_IN

NOT_IN: "notin" = "notin"

Static Readonly NOT_LIKE

NOT_LIKE: "notlike" = "notlike"

Methods

between

between(min: string, max: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:168
Sets given value and operation to between for this filter. Only 2 values allowed.

Parameters
- min: string
- max: string
Returns IFilter

IFilter

equalTo

equalTo(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:70
Sets given value and operation to equal to for this filter

Parameters
- value: string
Returns IFilter

IFilter

greaterThan

greaterThan(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:134
Sets given value and operation to greater than for this filter

Parameters
- value: string
Returns IFilter

IFilter

greaterThanOrEqualTo

greaterThanOrEqualTo(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:150
Sets given value and operation to greater than or equal to for this filter

Parameters
- value: string
Returns IFilter

IFilter

in

in(values: string[]): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:184
Sets given values and operation to in for this filter.

Parameters
- values: string[]
Returns IFilter

IFilter

isNotNull

isNotNull(): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:257
Sets given values and operation to is not null for this filter.

Returns IFilter

IFilter

isNull

isNull(): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:247
Sets given values and operation to is null for this filter.

Returns IFilter

IFilter

lessThan

lessThan(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:102
Sets given value and operation to less than for this filter

Parameters
- value: string
Returns IFilter

IFilter

lessThanOrEqualTo

lessThanOrEqualTo(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:118
Sets given value and operation to less than or equal to for this filter

Parameters
- value: string
Returns IFilter

IFilter

like

like(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:216
Sets given values and operation to like for this filter.

Parameters
- value: string
Returns IFilter

IFilter

notEqualTo

notEqualTo(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:86
Sets given value and operation to not equal to for this filter

Parameters
- value: string
Returns IFilter

IFilter

notIn

notIn(values: string[]): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:200
Sets given values and operation to not in for this filter.

Parameters
- values: string[]
Returns IFilter

IFilter

notLike

notLike(value: string): IFilter

- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:232
Sets given values and operation to not like for this filter.

Parameters
- value: string
Returns IFilter

IFilter

writeXml

writeXml(xml: IaXmlWriter): void

Implementation of IFilter.writeXml
- Defined in src/Functions/Common/NewQuery/QueryFilter/Filter.ts:263
Parameters
- xml: IaXmlWriter
Returns void

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fieldName: string

Returns Filter

Properties

Private Readonly fieldName

Private operation

Private value

Static Readonly BETWEEN

Static Readonly EQUAL_TO

Static Readonly GREATER_THAN

Static Readonly GREATER_THAN_OR_EQUAL_TO

Static Readonly IN

Static Readonly IS_NOT_NULL

Static Readonly IS_NULL

Static Readonly LESS_THAN

Static Readonly LESS_THAN_OR_EQUAL_TO

Static Readonly LIKE

Static Readonly NOT_EQUAL_TO

Static Readonly NOT_IN

Static Readonly NOT_LIKE

Methods

between

Parameters

min: string

max: string

Returns IFilter

equalTo

Parameters

value: string

Returns IFilter

greaterThan

Parameters

value: string

Returns IFilter

greaterThanOrEqualTo

Parameters

value: string

Returns IFilter

in

Parameters

values: string[]

Returns IFilter

isNotNull

Returns IFilter

isNull

Returns IFilter

lessThan

Parameters

value: string

Returns IFilter

lessThanOrEqualTo

Parameters

value: string

Returns IFilter

like

Parameters

value: string

Returns IFilter

notEqualTo

Parameters

value: string

Returns IFilter

notIn

Parameters

values: string[]

Returns IFilter

notLike

Parameters

value: string

Returns IFilter

writeXml

Parameters