Constructor
new ListQueryRequest()
ListQueryRequest Constructor.
ListQueryRequest Constructor.
Members
(static, constant) SORT_ASCENDING
- Source:
(static, constant) SORT_DESCENDING
- Source:
Methods
addOnDemandColumn(column) → {ListQueryRequest}
Add an on demand column to the request.
Add an on demand column to the request.
Parameters:
| Name | Type | Description |
|---|---|---|
column |
string | Array |
- Source:
Throws:
Returns:
- Type
- ListQueryRequest
createResponse(data) → {Response}
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object |
- Source:
Returns:
- Type
- Response
filterExpression() → {FilterExpression}
Creates a new FilterExpression object in the context the request.
Creates a new FilterExpression object in the context the request.
- Source:
Returns:
- Type
- FilterExpression
getAvailableCustomFilters() → {Array}
Get the available custom filters for the request.
Get the available custom filters for the request.
- Source:
Returns:
- Type
- Array
getAvailableOnDemandColumns() → {Array}
Get the available on demand columns for the request.
Get the available on demand columns for the request.
- Source:
Returns:
- Type
- Array
getAvailableSearchFields() → {Array}
Get the available search fields for the request.
Get the available search fields for the request.
- Source:
Returns:
- Type
- Array
getAvailableSortFields() → {Array}
Get the available sorting fields for the request.
Get the available sorting fields for the request.
- Source:
Returns:
- Type
- Array
getCount() → {number}
Get the maximum records to request.
Get the maximum records to request.
- Source:
Returns:
- Type
- number
getCustomFilters() → {Array}
Get the custom filters to apply.
Get the custom filters to apply.
- Source:
Returns:
- Type
- Array
getFilters() → {Array|FilterExpression}
Get the search filters to apply to the request.
Get the search filters to apply to the request.
- Source:
Returns:
- Type
- Array | FilterExpression
getOffset() → {*}
Get the record offset.
Get the record offset.
- Source:
Returns:
- Type
- *
getOnDemandColumns() → {Array}
Get the on demand columns to fetch.
Get the on demand columns to fetch.
- Source:
Returns:
- Type
- Array
getSort() → {*}
Get the sorting field.
Get the sorting field.
- Source:
Returns:
- Type
- *
removeCustomFilter(name) → {ListQueryRequest}
Remove a custom filter applied to the request.
Remove a custom filter applied to the request.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string |
- Source:
Returns:
- Type
- ListQueryRequest
removeOnDemandColumn(column) → {ListQueryRequest}
Remove an on demand column from the request.
Remove an on demand column from the request.
Parameters:
| Name | Type | Description |
|---|---|---|
column |
string | Array |
- Source:
Returns:
- Type
- ListQueryRequest
setCount(count) → {ListQueryRequest}
Set the maximum records to request.
Set the maximum records to request.
Parameters:
| Name | Type | Description |
|---|---|---|
count |
number |
- Source:
Returns:
- Type
- ListQueryRequest
setCustomFilter(name, value) → {ListQueryRequest}
Set a custom filter supported by the request.
Set a custom filter supported by the request.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The custom filter name |
value |
* | The custom filter value |
- Source:
Throws:
Returns:
- Type
- ListQueryRequest
setFilters(filters) → {ListQueryRequest}
Set the search filters to apply to the request.
Set the search filters to apply to the request.
Parameters:
| Name | Type | Description |
|---|---|---|
filters |
Array | FilterExpression |
- Source:
Throws:
Returns:
- Type
- ListQueryRequest
setOffset(offset) → {ListQueryRequest}
Set the record offset.
Set the record offset.
Parameters:
| Name | Type | Description |
|---|---|---|
offset |
number |
- Source:
Returns:
- Type
- ListQueryRequest
setOnDemandColumns(columns) → {ListQueryRequest}
Set the on demand columns to fetch.
Set the on demand columns to fetch.
Parameters:
| Name | Type | Description |
|---|---|---|
columns |
Array |
- Source:
Returns:
- Type
- ListQueryRequest
setSort(field, direction) → {ListQueryRequest}
Set the sorting field.
Set the sorting field.
Parameters:
| Name | Type | Description |
|---|---|---|
field |
string | |
direction |
string |
- Source:
Returns:
- Type
- ListQueryRequest
toObject()
Reduce the request to an Object.
Reduce the request to an Object.
- Source:
Returns:
Object