# Class: DataRetrieval

## Constructor

#### new DataRetrieval(dataSet)

  These API is internal to the SDK library and their use by third party applications could result in unpredictable behavior of the resulting application. No support will be provided by Avaya related to the use of any internal APIs.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `dataSet` | AvayaClientServices.Base.DataSet |

## Members

#### isCancelled :boolean

  ##### Type:

  - boolean

#### isCompleted :boolean

  ##### Type:

  - boolean

## Methods

#### cancel() → {void}

  Cancels this data retrieval operation

  ##### Returns:

  { void }

#### getDataSet() → {AvayaClientServices.Base.DataSet}

  ##### Returns:

  { AvayaClientServices.Base.DataSet }

### DataRetrieval callbacks

#### addOnDataRetrievalDoneCallback(callback) → {void}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | AvayaClientServices.Base.DataRetrieval#onDataRetrievalDone |

  ##### Returns:

  { void }

#### addOnDataRetrievalFailedCallback(callback) → {void}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | AvayaClientServices.Base.DataRetrieval#onDataRetrievalFailed |

  ##### Returns:

  { void }

#### addOnDataRetrievalProgressCallback(callback) → {void}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | AvayaClientServices.Base.DataRetrieval#onDataRetrievalProgress |

  ##### Returns:

  { void }

#### removeOnDataRetrievalDoneCallback(callback) → {void}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | AvayaClientServices.Base.DataRetrieval#onDataRetrievalDone |

  ##### Returns:

  { void }

#### removeOnDataRetrievalFailedCallback(callback) → {void}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | AvayaClientServices.Base.DataRetrieval#onDataRetrievalFailed |

  ##### Returns:

  { void }

#### removeOnDataRetrievalProgressCallback(callback) → {void}

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `callback` | AvayaClientServices.Base.DataRetrieval#onDataRetrievalProgress |

  ##### Returns:

  { void }

## Type Definitions

#### onDataRetrievalDone(allResultsRetrieved, total) → {void}

  Interface for callback function to be invoked when the retrieval process is done.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `allResultsRetrieved` | boolean | undefined | a boolean indicating if all results for this data retrieval operation were retrieved. True for yes, false for no, undefined if we don't know.
  `total` | number | undefined | If allResultsRetrieved is true this will indicate the number of results retrieved otherwise it will be undefined.

  ##### Returns:

  { void }

#### onDataRetrievalFailed(error) → {void}

  Interface for callback function to be invoked when the retrieval process is done.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `error` | AvayaClientServices.Base.BaseError |

  ##### Returns:

  { void }

#### onDataRetrievalProgress(retrievedCount, determinate, total) → {void}

  Interface for callback function to be invoked on retrieval progress.

  ##### Parameters:

  Name | Type | Argument | Description
  --- | --- | --- | ---
  `retrievedCount` | number |  | The number of elements that have been retrieved so far.
  `determinate` | boolean |  | indicates if the total number of elements in the retrieval is known
  `total` | number | <optional> | The total number of elements. This will be undefined if determinate is false.

  ##### Returns:

  { void }