> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pba-ctools/pentaho-cdf-api/queries/cdaquery.md). # CdaQuery ## cdf.queries. CdaQuery Static Class that represents a CDA query. This class will be registered globally using the static dashboard function `registerGlobalQuery`. The constructor of this class is created dynamically and registered in the dashboard query container `queryFactories`. To create a new CDA query use the dashboard function `getQuery`. \*\*Source:\*\*queries/CdaQuery.js, line 27 ## Extends cdf.queries.BaseQuery ## Example ``` dashboard.addDataSource("myCdaQuery", { queryType: "cda", dataAccessId: "cdaQuery", path: "/public/myQ.cda" }); dashboard.getQuery({dataSource: "myCdaQuery"}).doQuery(successCallback, errorCallback); ``` ## Members | Name | Description | | ------------------------------------------------------- | -------------------------------------------------------------- | | \_label : `string`Constant Protected | The class label. | | \_name : `string`Constant Protected | The class name. | | dashboard : `cdf.dashboard.Dashboard`Protected | A reference to the dashboard instance. | | deepProperties : ``Array.<`string`>``Constant Protected | A list of properties to be extended to the registered queries. | | defaults : `Object`Protected | The default properties. | | interfaces : `Object`Protected | The default interfaces. | ## Methods | Name | Description | | ------------------------------------------------------------- | ----------------------------------------------------------------------------- | | buildQueryDefinition(overrides) : `object` | Builds the query definition object. | | dispose() | Dispose the query object. | | doQuery(successCallback, errorCallback) | Executes a server-side query. | | exportData(outputType, overrides, options) | Exports the data, according to a specific output type. | | fetchData(params, successCallback, errorCallback) : `Object` | Fetches the data. | | getErrorHandler(callback) : `function` | Gets the error callback handler. | | getOption(prop) : `Object` | Gets an option (fallback for when the OptionManager is not available). | | getPage(targetPage, outsideCallback) : `boolean` \| `Object` | Gets the set of results for the page at index `targetPage` (0-indexed). | | getSuccessHandler(callback) : `function` | Gets the success callback handler. | | init(opts) | Initializes a CDA query. | | initPage(pageSize, outsideCallback) : `boolean` \| `Object` | Sets the page size and gets the first page of results. | | lastProcessedResults() : `Object` | Gets the last retrieved result after being processed by postFetch. | | lastResults() : `Object` | Gets the last retrieved result. | | nextPage(outsideCallback) : `Object` | Gets the next page of results, as controlled by the `pageSize` option. | | pageStartingAt(page, outsideCallback) : `boolean` \| `Object` | Runs the query, setting a starting page before doing so. | | previousPage(outsideCallback) : `Object` | Gets the previous page of results, as controlled by the `pageSize` option. | | reprocessLastResults(outerCallback) : `Object` | Reruns the success callback on the last retrieved result set from the server. | | reprocessResults(outsideCallback) : `Object` | Alias for `reprocessLastResults`. | | setAjaxOptions(newOptions) | Sets the jQuery.ajax options for the query. | | setCallback(callback) | Sets the success callback for the query. | | setErrorCallback(callback) | Sets the error callback for the query. | | setOption(prop, value) | Sets an option (fallback for when the OptionManager is not available). | | setPageSize(pageSize) | Sets the page size. | | setPageStartingAt(targetPage) : `boolean` | Sets the starting page for later executions of the query. | | setParameters(params) | Sets query parameters. | | setSearchPattern(pattern) | Sets the search pattern for the query. | | setSortBy(sortBy) : `boolean` | Sets the sort by columns. | | sortBy(sortBy, outsideCallback) : `boolean` \| `Object` | Sorts the result set. | ## Members Details | \_label: `string`Constant Protected | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

The class label.

\*\*Source:\*\*queries/CdaQuery.js, line 74

Default Value:"CDA Query"

\*\*Overrides:\*\*cdf.queries.BaseQuery#\_label

| | \_name: `string`Constant Protected | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |

The class name.

\*\*Source:\*\*queries/CdaQuery.js, line 59

Default Value:"cda"

\*\*Overrides:\*\*cdf.queries.BaseQuery#\_name

| | dashboard: `cdf.dashboard.Dashboard`Protected | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

A reference to the dashboard instance.

\*\*Source:\*\*queries/BaseQuery.js, line 76

Inherited From: cdf.queries.BaseQuery#dashboard

|
deepProperties: Array.<`string`>Constant Protected

A list of properties to be extended to the registered queries that do not provide their own constructor function.

**Source:**queries/BaseQuery.js, line 67

Inherited From: cdf.queries.BaseQuery#deepProperties

Default Value:

`["defaults","interfaces"]`

See also:registerQuery

| defaults: `Object`Protected | | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -------------------------------------- | |

The default properties.

\*\*Source:\*\*queries/CdaQuery.js, line 93

\*\*Overrides:\*\*cdf.queries.BaseQuery#defaults

| | | | Name | Default Value | Description | | url : `string` | | The target endpoint URL. | | file : `string` | "" | The target file name. | | id : `string` | "" | The target identifier. | | outputIdx : `string` | "1" | The default output index. | | sortBy : `string` | "" | The default sorting order. | | ajaxOptions : `Object` | {async:true,xhrFields:{withCredentials:true}} | The jQuery.ajax options for the query. | | searchPattern : `string` | "" | The default search pattern. | | Name | Default Value | Description | | ------------------------ | --------------------------------------------- | -------------------------------------- | | url : `string` | | The target endpoint URL. | | file : `string` | "" | The target file name. | | id : `string` | "" | The target identifier. | | outputIdx : `string` | "1" | The default output index. | | sortBy : `string` | "" | The default sorting order. | | ajaxOptions : `Object` | {async:true,xhrFields:{withCredentials:true}} | The jQuery.ajax options for the query. | | searchPattern : `string` | "" | The default search pattern. | | interfaces: `Object`Protected | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ---------------------------- | |

The default interfaces.

\*\*Source:\*\*queries/BaseQuery.js, line 138

Inherited From: cdf.queries.BaseQuery#interfaces

| | | | Name | Default Value | Description | | params : `Object` | | Parameter interfaces. | | Name | Default Value | Description | | reader : `string` | "propertiesObject" | Parameter reader. | | validator : `string` | "isObjectOrPropertiesArray" | Parameter validator. | | successCallback : `Object` | | Success callback interfaces. | | Name | Default Value | Description | | validator : `string` | "isFunction" | Success callback validator. | | errorCallback : `Object` | | Error callback interfaces. | | Name | Default Value | Description | | validator : `string` | "isFunction" | Error callback validator. | | pageSize : `Object` | | Page size interfaces. | | Name | Default Value | Description | | validator : `string` | "isPositive" | Page size validator. | | Name | Default Value | Description | | -------------------- | ------------- | -------------------- | | validator : `string` | "isPositive" | Page size validator. | | Name | Default Value | Description | | -------------------- | ------------- | ------------------------- | | validator : `string` | "isFunction" | Error callback validator. | | Name | Default Value | Description | | -------------------- | ------------- | --------------------------- | | validator : `string` | "isFunction" | Success callback validator. | | Name | Default Value | Description | | -------------------- | --------------------------- | -------------------- | | reader : `string` | "propertiesObject" | Parameter reader. | | validator : `string` | "isObjectOrPropertiesArray" | Parameter validator. | | Name | Default Value | Description | | -------------------------- | --------------------------- | ---------------------------- | | params : `Object` | | Parameter interfaces. | | Name | Default Value | Description | | reader : `string` | "propertiesObject" | Parameter reader. | | validator : `string` | "isObjectOrPropertiesArray" | Parameter validator. | | successCallback : `Object` | | Success callback interfaces. | | Name | Default Value | Description | | validator : `string` | "isFunction" | Success callback validator. | | errorCallback : `Object` | | Error callback interfaces. | | Name | Default Value | Description | | validator : `string` | "isFunction" | Error callback validator. | | pageSize : `Object` | | Page size interfaces. | | Name | Default Value | Description | | validator : `string` | "isPositive" | Page size validator. | | Name | Default Value | Description | | -------------------- | ------------- | -------------------- | | validator : `string` | "isPositive" | Page size validator. | | Name | Default Value | Description | | -------------------- | ------------- | ------------------------- | | validator : `string` | "isFunction" | Error callback validator. | | Name | Default Value | Description | | -------------------- | ------------- | --------------------------- | | validator : `string` | "isFunction" | Success callback validator. | | Name | Default Value | Description | | -------------------- | --------------------------- | -------------------- | | reader : `string` | "propertiesObject" | Parameter reader. | | validator : `string` | "isObjectOrPropertiesArray" | Parameter validator. | \## Methods Details | **buildQueryDefinition**(overrides) : `object` | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------------------------------- | |

Builds the query definition object.

\*\*Source:\*\*queries/CdaQuery.js, line 158

\*\*Overrides:\*\*cdf.queries.BaseQuery#buildQueryDefinition

| | | | Name | Default Value | Summary | | overrides : `object` | | New query definitions to override any existing query definitions. | | Name | Description | | | `object` | Query definition object. | | | Name | Description | | -------- | ------------------------ | | `object` | Query definition object. | | Name | Default Value | Summary | | -------------------- | ------------- | ----------------------------------------------------------------- | | overrides : `object` | | New query definitions to override any existing query definitions. | | **dispose**() | | ----------------------------------------------------------------------------------------------------------------------------------------- | |

Dispose the query object.

\*\*Source:\*\*queries/CdaQuery.js, line 431

\*\*Overrides:\*\*cdf.queries.BaseQuery#dispose

| | **doQuery**(successCallback, errorCallback) | | | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------- | |

Executes a server-side query.

\*\*Source:\*\*queries/CdaQuery.js, line 367

\*\*Overrides:\*\*cdf.queries.BaseQuery#doQuery

| | | | Name | Default Value | Summary | | successCallback : `function`Optional | | Success callback. | | errorCallback : `function`Optional | | Error callback. | | Name | Default Value | Summary | | ------------------------------------ | ------------- | ----------------- | | successCallback : `function`Optional | | Success callback. | | errorCallback : `function`Optional | | Error callback. | | **exportData**(outputType, overrides, options) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------- | |

Exports the data, according to a specific output type.

\*\*Source:\*\*queries/CdaQuery.js, line 207

\*\*Overrides:\*\*cdf.queries.BaseQuery#exportData

| | | | Name | Default Value | Summary | | outputType : `string` | | Output type (CSV, XLS, XML, HTML). | | overrides : `object` | | Overrides for the query definition object. | | options : `object` | | Export options. | | Name | Default Value | Summary | | separator : `string` | | Separator. | | filename : `string` | | File name. | | template : `string` | | Template name. | | columnHeaders : `object` | | The column headers. | | dtFilter : `object` | | Data table filter. | | dtSearchableColumns : `object` | | Data table searchable columns. | | exportPage : `boolean` | | Export only one page (true) or full data set (false). | | Name | Default Value | Summary | | ------------------------------ | ------------- | ----------------------------------------------------- | | separator : `string` | | Separator. | | filename : `string` | | File name. | | template : `string` | | Template name. | | columnHeaders : `object` | | The column headers. | | dtFilter : `object` | | Data table filter. | | dtSearchableColumns : `object` | | Data table searchable columns. | | exportPage : `boolean` | | Export only one page (true) or full data set (false). | | Name | Default Value | Summary | | ------------------------------ | ------------- | ----------------------------------------------------- | | outputType : `string` | | Output type (CSV, XLS, XML, HTML). | | overrides : `object` | | Overrides for the query definition object. | | options : `object` | | Export options. | | Name | Default Value | Summary | | separator : `string` | | Separator. | | filename : `string` | | File name. | | template : `string` | | Template name. | | columnHeaders : `object` | | The column headers. | | dtFilter : `object` | | Data table filter. | | dtSearchableColumns : `object` | | Data table searchable columns. | | exportPage : `boolean` | | Export only one page (true) or full data set (false). | | Name | Default Value | Summary | | ------------------------------ | ------------- | ----------------------------------------------------- | | separator : `string` | | Separator. | | filename : `string` | | File name. | | template : `string` | | Template name. | | columnHeaders : `object` | | The column headers. | | dtFilter : `object` | | Data table filter. | | dtSearchableColumns : `object` | | Data table searchable columns. | | exportPage : `boolean` | | Export only one page (true) or full data set (false). | | **fetchData**(params, successCallback, errorCallback) : `Object` | | | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------- | |

Fetches the data.

\*\*Source:\*\*queries/BaseQuery.js, line 350

Inherited From: cdf.queries.BaseQuery#fetchData

| | | | Name | Default Value | Summary | | params : `Object` | | Parameters for the query. | | successCallback : `function` | | Success callback. | | errorCallback : `function` | | Error callback. | | Name | Description | | | `Object` | The result of calling `doQuery` with the specified arguments. | | | Name | Description | | | `InvalidInput` | If the arguments are not correct. | | | Name | Description | | -------------- | --------------------------------- | | `InvalidInput` | If the arguments are not correct. | | Name | Description | | -------- | ------------------------------------------------------------- | | `Object` | The result of calling `doQuery` with the specified arguments. | | Name | Default Value | Summary | | ---------------------------- | ------------- | ------------------------- | | params : `Object` | | Parameters for the query. | | successCallback : `function` | | Success callback. | | errorCallback : `function` | | Error callback. | | **getErrorHandler**(callback) : `function` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------------------------------ | |

Gets the error callback handler that executes the provided callback when the query fails to execute.

\*\*Source:\*\*queries/BaseQuery.js, line 253

Inherited From: cdf.queries.BaseQuery#getErrorHandler

| | | | Name | Default Value | Summary | | callback : `function` | | Callback to call if the query fails. | | Name | Description | | | `function` | Error callback handler. | | | Name | Description | | ---------- | ----------------------- | | `function` | Error callback handler. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------------------ | | callback : `function` | | Callback to call if the query fails. | | **getOption**(prop) : `Object` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------------------------------------- | |

Gets an option (fallback for when the OptionManager is not available).

\*\*Source:\*\*queries/BaseQuery.js, line 183

Inherited From: cdf.queries.BaseQuery#getOption

| | | | Name | Default Value | Summary | | prop : `string` | | The property from where to get the options. | | Name | Description | | | `Object` | Value for the option. | | | Name | Description | | -------- | --------------------- | | `Object` | Value for the option. | | Name | Default Value | Summary | | --------------- | ------------- | ------------------------------------------- | | prop : `string` | | The property from where to get the options. | | **getPage**(targetPage, outsideCallback) : `boolean` \| `Object` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | |

Gets the set of results for the page at index targetPage (0-indexed).

\*\*Source:\*\*queries/BaseQuery.js, line 580

Inherited From: cdf.queries.BaseQuery#getPage

| | | | Name | Default Value | Summary | | targetPage : `number` | | Index of the page to get, starting at index 0. | | outsideCallback : `function` | | Success callback to execute when the page is retrieved. | | Name | Description | | | `boolean` \| `Object` | `false` if the page is already the current one, otherwise returns the result of calling `doQuery`. | | | Name | Description | | | `InvalidPage` | If `targetPage` is not a positive number. | | | Name | Description | | ------------- | ----------------------------------------- | | `InvalidPage` | If `targetPage` is not a positive number. | | Name | Description | | --------------------- | -------------------------------------------------------------------------------------------------- | | `boolean` \| `Object` | `false` if the page is already the current one, otherwise returns the result of calling `doQuery`. | | Name | Default Value | Summary | | ---------------------------- | ------------- | ------------------------------------------------------- | | targetPage : `number` | | Index of the page to get, starting at index 0. | | outsideCallback : `function` | | Success callback to execute when the page is retrieved. | | **getSuccessHandler**(callback) : `function` | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | ----------------------------------------------- | |

Gets the success callback handler that executes the provided callback when the query executes successfully.

\*\*Source:\*\*queries/BaseQuery.js, line 230

Inherited From: cdf.queries.BaseQuery#getSuccessHandler

| | | | Name | Default Value | Summary | | callback : `function` | | Callback to call after the query is successful. | | Name | Description | | | `function` | Success callback handler. | | | Name | Description | | ---------- | ------------------------- | | `function` | Success callback handler. | | Name | Default Value | Summary | | --------------------- | ------------- | ----------------------------------------------- | | callback : `function` | | Callback to call after the query is successful. | | **init**(opts) | | | | | | | | | | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------- | - | ---- | ----------- | - | -------------- | ----------------------------------------------------------------------------- | ---- | - | - | |

Initializes a CDA query.

\*\*Source:\*\*queries/CdaQuery.js, line 125

\*\*Overrides:\*\*cdf.queries.BaseQuery#init

| Name | Description | | ---- | ----------- | | `InvalidQuery` | If the `opts` parameter does not contain a path nor a data access identifier. |

| | | | Name | Default Value | Summary | | | | | | | | | | | opts : `object` | | The query definition object. | | | | | | | | | | | Name | Default Value | Summary | | | | | | | | | | | path : `string` | | The path to the CDA file. | | | | | | | | | | | dataAccessId : `string` | | The Data access identifier. | | | | | | | | | | | sortBy : `string`Optional | | The sorting order. | | | | | | | | | | | pageSize : `number`Optional | | The page size. | | | | | | | | | | | outputIndexId : `number`Optional | | The output index identifier. | | | | | | | | | | | pushEnabled : `boolean`Optional | | If the query should run in push mode. | | | | | | | | | | | Name | Default Value | Summary | | -------------------------------- | ------------- | ------------------------------------- | | path : `string` | | The path to the CDA file. | | dataAccessId : `string` | | The Data access identifier. | | sortBy : `string`Optional | | The sorting order. | | pageSize : `number`Optional | | The page size. | | outputIndexId : `number`Optional | | The output index identifier. | | pushEnabled : `boolean`Optional | | If the query should run in push mode. | | Name | Default Value | Summary | | -------------------------------- | ------------- | ------------------------------------- | | opts : `object` | | The query definition object. | | Name | Default Value | Summary | | path : `string` | | The path to the CDA file. | | dataAccessId : `string` | | The Data access identifier. | | sortBy : `string`Optional | | The sorting order. | | pageSize : `number`Optional | | The page size. | | outputIndexId : `number`Optional | | The output index identifier. | | pushEnabled : `boolean`Optional | | If the query should run in push mode. | | Name | Default Value | Summary | | -------------------------------- | ------------- | ------------------------------------- | | path : `string` | | The path to the CDA file. | | dataAccessId : `string` | | The Data access identifier. | | sortBy : `string`Optional | | The sorting order. | | pageSize : `number`Optional | | The page size. | | outputIndexId : `number`Optional | | The output index identifier. | | pushEnabled : `boolean`Optional | | If the query should run in push mode. | | **initPage**(pageSize, outsideCallback) : `boolean` \| `Object` | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------- | |

Sets the page size and gets the first page of results.

\*\*Source:\*\*queries/BaseQuery.js, line 652

Inherited From: cdf.queries.BaseQuery#initPage

| | | | Name | Default Value | Summary | | pageSize : `number` | | Page Size. | | outsideCallback : `function` | | Success callback to execute after query is retrieved. | | Name | Description | | | `boolean` \| `Object` | `false` if pageSize is invalid, otherwise the result of calling `doQuery`. | | | Name | Description | | | `InvalidPageSize` | If the page size is not a positive number. | | | Name | Description | | ----------------- | ------------------------------------------ | | `InvalidPageSize` | If the page size is not a positive number. | | Name | Description | | --------------------- | -------------------------------------------------------------------------- | | `boolean` \| `Object` | `false` if pageSize is invalid, otherwise the result of calling `doQuery`. | | Name | Default Value | Summary | | ---------------------------- | ------------- | ----------------------------------------------------- | | pageSize : `number` | | Page Size. | | outsideCallback : `function` | | Success callback to execute after query is retrieved. | | **lastProcessedResults**() : `Object` | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | |

Gets the last retrieved result after being processed by postFetch.

\*\*Source:\*\*queries/BaseQuery.js, line 432

Inherited From: cdf.queries.BaseQuery#lastProcessedResults

| | | Name | Description | | `Object` | A deep copy of the the last result set obtained from the server after being processed by postFetch. | | Name | Description | | `NoCachedResults` | If there have not been previous calls to the server. | | Name | Description | | ----------------- | ---------------------------------------------------- | | `NoCachedResults` | If there have not been previous calls to the server. | | Name | Description | | -------- | --------------------------------------------------------------------------------------------------- | | `Object` | A deep copy of the the last result set obtained from the server after being processed by postFetch. | | **lastResults**() : `Object` | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | |

Gets the last retrieved result.

\*\*Source:\*\*queries/BaseQuery.js, line 416

Inherited From: cdf.queries.BaseQuery#lastResults

| | | Name | Description | | `Object` | A deep copy of the last result set obtained from the server. | | Name | Description | | `NoCachedResults` | If there have not been previous calls to the server. | | Name | Description | | ----------------- | ---------------------------------------------------- | | `NoCachedResults` | If there have not been previous calls to the server. | | Name | Description | | -------- | ------------------------------------------------------------ | | `Object` | A deep copy of the last result set obtained from the server. | | **nextPage**(outsideCallback) : `Object` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | ----------------------------------------------------------------------- | |

Gets the next page of results, as controlled by the pageSize option.

\*\*Source:\*\*queries/BaseQuery.js, line 534

Inherited From: cdf.queries.BaseQuery#nextPage

| | | | Name | Default Value | Summary | | outsideCallback : `function` | | Success callback to execute when the next page of results is retrieved. | | Name | Description | | | `Object` | The result of calling `doQuery`. | | | Name | Description | | | `InvalidPageSize` | If the page size option is not a positive number. | | | Name | Description | | ----------------- | ------------------------------------------------- | | `InvalidPageSize` | If the page size option is not a positive number. | | Name | Description | | -------- | -------------------------------- | | `Object` | The result of calling `doQuery`. | | Name | Default Value | Summary | | ---------------------------- | ------------- | ----------------------------------------------------------------------- | | outsideCallback : `function` | | Success callback to execute when the next page of results is retrieved. | | **pageStartingAt**(page, outsideCallback) : `boolean` \| `Object` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------- | |

Runs the query, setting a starting page before doing so. If the starting page matches the already selected one, the query run is canceled and false is returned.

\*\*Source:\*\*queries/BaseQuery.js, line 624

Inherited From: cdf.queries.BaseQuery#pageStartingAt

| | | | Name | Default Value | Summary | | page : `number` | | Starting page index. | | outsideCallback : `function` | | Success callback to execute after the server-side query is processed. | | Name | Description | | | `boolean` \| `Object` | `false` if the query run is canceled, otherwise the result of calling `doQuery`. | | | Name | Description | | --------------------- | -------------------------------------------------------------------------------- | | `boolean` \| `Object` | `false` if the query run is canceled, otherwise the result of calling `doQuery`. | | Name | Default Value | Summary | | ---------------------------- | ------------- | --------------------------------------------------------------------- | | page : `number` | | Starting page index. | | outsideCallback : `function` | | Success callback to execute after the server-side query is processed. | | **previousPage**(outsideCallback) : `Object` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | --------------------------------------------------------------------------- | |

Gets the previous page of results, as controlled by the pageSize option.

\*\*Source:\*\*queries/BaseQuery.js, line 555

Inherited From: cdf.queries.BaseQuery#previousPage

| | | | Name | Default Value | Summary | | outsideCallback : `function` | | Success callback to execute when the previous page of results is retrieved. | | Name | Description | | | `Object` | The result of calling `doQuery`. | | | Name | Description | | | `AtBeginning` | If current page is the first one. | | | Name | Description | | ------------- | --------------------------------- | | `AtBeginning` | If current page is the first one. | | Name | Description | | -------- | -------------------------------- | | `Object` | The result of calling `doQuery`. | | Name | Default Value | Summary | | ---------------------------- | ------------- | --------------------------------------------------------------------------- | | outsideCallback : `function` | | Success callback to execute when the previous page of results is retrieved. | | **reprocessLastResults**(outerCallback) : `Object` | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ----------------- | |

Reruns the success callback on the last retrieved result set from the server.

\*\*Source:\*\*queries/BaseQuery.js, line 449

Inherited From: cdf.queries.BaseQuery#reprocessLastResults

See also:reprocessResults

| | | | Name | Default Value | Summary | | outerCallback : `function` | | Success callback. | | Name | Description | | | `Object` | The result of calling the specified callback. | | | Name | Description | | | `NoCachedResults` | If there have not been previous calls to the server. | | | Name | Description | | ----------------- | ---------------------------------------------------- | | `NoCachedResults` | If there have not been previous calls to the server. | | Name | Description | | -------- | --------------------------------------------- | | `Object` | The result of calling the specified callback. | | Name | Default Value | Summary | | -------------------------- | ------------- | ----------------- | | outerCallback : `function` | | Success callback. | | **reprocessResults**(outsideCallback) : `Object` | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ----------------- | |

Alias for reprocessLastResults.

\*\*Source:\*\*queries/BaseQuery.js, line 474

Inherited From: cdf.queries.BaseQuery#reprocessResults

See also:reprocessLastResults

| | | | Name | Default Value | Summary | | outsideCallback : `function` | | Success callback. | | Name | Description | | | `Object` | The result of calling the specified callback. | | | Name | Description | | | `NoCachedResults` | If there have not been previous calls to the server. | | | Name | Description | | ----------------- | ---------------------------------------------------- | | `NoCachedResults` | If there have not been previous calls to the server. | | Name | Description | | -------- | --------------------------------------------- | | `Object` | The result of calling the specified callback. | | Name | Default Value | Summary | | ---------------------------- | ------------- | ----------------- | | outsideCallback : `function` | | Success callback. | | **setAjaxOptions**(newOptions) | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------- | |

Sets the jQuery.ajax options for the query.

\*\*Source:\*\*queries/BaseQuery.js, line 299

Inherited From: cdf.queries.BaseQuery#setAjaxOptions

| | | | Name | Default Value | Summary | | newOptions : `Object` | | Ajax options to be added. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------- | | newOptions : `Object` | | Ajax options to be added. | | **setCallback**(callback) | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------ | |

Sets the success callback for the query.

\*\*Source:\*\*queries/BaseQuery.js, line 494

Inherited From: cdf.queries.BaseQuery#setCallback

| | | | Name | Default Value | Summary | | callback : `function` | | The success callback function. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------------ | | callback : `function` | | The success callback function. | | **setErrorCallback**(callback) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------------- | |

Sets the error callback for the query.

\*\*Source:\*\*queries/BaseQuery.js, line 504

Inherited From: cdf.queries.BaseQuery#setErrorCallback

| | | | Name | Default Value | Summary | | callback : `function` | | The error callback function. | | Name | Default Value | Summary | | --------------------- | ------------- | ---------------------------- | | callback : `function` | | The error callback function. | | **setOption**(prop, value) | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------------------------------------- | |

Sets an option (fallback for when the OptionManager is not available).

\*\*Source:\*\*queries/BaseQuery.js, line 194

Inherited From: cdf.queries.BaseQuery#setOption

| | | | Name | Default Value | Summary | | prop : `string` | | The property for which the value will be set. | | value : `Object` | | Value for the property. | | Name | Default Value | Summary | | ---------------- | ------------- | --------------------------------------------- | | prop : `string` | | The property for which the value will be set. | | value : `Object` | | Value for the property. | | **setPageSize**(pageSize) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------- | |

Sets the page size.

\*\*Source:\*\*queries/BaseQuery.js, line 638

Inherited From: cdf.queries.BaseQuery#setPageSize

| | | | Name | Default Value | Summary | | pageSize : `number` | | Page size to set. | | Name | Default Value | Summary | | ------------------- | ------------- | ----------------- | | pageSize : `number` | | Page size to set. | | **setPageStartingAt**(targetPage) : `boolean` | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------- | |

Sets the starting page for later executions of the query.

\*\*Source:\*\*queries/BaseQuery.js, line 602

Inherited From: cdf.queries.BaseQuery#setPageStartingAt

| | | | Name | Default Value | Summary | | targetPage : `number` | | Index of the page to get. | | Name | Description | | | `boolean` | `true` if the page is correctly set, `false` if the target page is already the selected one. | | | Name | Description | | | `InvalidPage` | If the page number is not a positive number. | | | Name | Description | | ------------- | -------------------------------------------- | | `InvalidPage` | If the page number is not a positive number. | | Name | Description | | --------- | -------------------------------------------------------------------------------------------- | | `boolean` | `true` if the page is correctly set, `false` if the target page is already the selected one. | | Name | Default Value | Summary | | --------------------- | ------------- | ------------------------- | | targetPage : `number` | | Index of the page to get. | | **setParameters**(params) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | --------------------- | |

Sets query parameters.

\*\*Source:\*\*queries/BaseQuery.js, line 484

Inherited From: cdf.queries.BaseQuery#setParameters

| | | | Name | Default Value | Summary | | params : `Object` | | The query parameters. | | Name | Default Value | Summary | | ----------------- | ------------- | --------------------- | | params : `Object` | | The query parameters. | | **setSearchPattern**(pattern) | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------- | |

Sets the search pattern for the query.

\*\*Source:\*\*queries/BaseQuery.js, line 514

Inherited From: cdf.queries.BaseQuery#setSearchPattern

| | | | Name | Default Value | Summary | | pattern : `string` | | The search pattern. | | Name | Default Value | Summary | | ------------------ | ------------- | ------------------- | | pattern : `string` | | The search pattern. | | **setSortBy**(sortBy) : `boolean` | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------- | |

Sets the sort by columns.

CDA expects an array of terms consisting of a number and a letter that's either "A" or "D". Each term denotes, in order, a column number and a sort direction: "0A" would then be sorting the first column ascending, and "1D" would sort the second column in descending order. This function accepts either an array with the search terms, or a comma-separated string with the terms: "0A,1D" would then mean the same as the array \["0A","1D"], which would sort the results first by the first column (ascending), and then by the second column (descending).

\*\*Source:\*\*queries/CdaQuery.js, line 280

\*\*Overrides:\*\*cdf.queries.BaseQuery#setSortBy

| | | | Name | Default Value | Summary | | sortBy : `string` \| `Array.<`string`>` | | Sorting columns order. | | Name | Description | | | `boolean` | `true` if the sort by condition has changed, `false` if it remained the same. | | | Name | Description | | | `InvalidSortExpression` | If the sort by columns are not correctly defined. | | | Name | Description | | ----------------------- | ------------------------------------------------- | | `InvalidSortExpression` | If the sort by columns are not correctly defined. | | Name | Description | | --------- | ----------------------------------------------------------------------------- | | `boolean` | `true` if the sort by condition has changed, `false` if it remained the same. | | Name | Default Value | Summary | | --------------------------------------- | ------------- | ---------------------- | | sortBy : `string` \| `Array.<`string`>` | | Sorting columns order. | | **sortBy**(sortBy, outsideCallback) : `boolean` \| `Object` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ | |

Sorts the result set. See the notes on sort columns on the setSortBy method.

\*\*Source:\*\*queries/CdaQuery.js, line 348

\*\*Overrides:\*\*cdf.queries.BaseQuery#sortBy

| | | | Name | Default Value | Summary | | sortBy : `string` | | Sorting columns order. | | outsideCallback : `function` | | Callback to call after the sorting has been processed. | | Name | Description | | | `boolean` \| `Object` | `false` if the sort by conditions have not changed, the result of calling `doQuery` otherwise. | | | Name | Description | | --------------------- | ---------------------------------------------------------------------------------------------- | | `boolean` \| `Object` | `false` if the sort by conditions have not changed, the result of calling `doQuery` otherwise. | | Name | Default Value | Summary | | ---------------------------- | ------------- | ------------------------------------------------------ | | sortBy : `string` | | Sorting columns order. | | outsideCallback : `function` | | Callback to call after the sorting has been processed. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.pentaho.com/pba-ctools/pentaho-cdf-api/queries/cdaquery.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.