analytics/webcontent/bi/js/dashboard-analytics/features/dashboard/queryService/api/QueryResultAPI.js

'use strict';

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

/**
 * Licensed Materials - Property of IBM
 * IBM Business Analytics (C) Copyright IBM Corp. 2018, 2020
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @interface QueryResultAPI
 * @hideconstructor
 * @classdesc API class that is used to access a query result object.
 * @example queryResults.getResult()
 */
define([], function () {
	var QueryResultAPI = function () {
		function QueryResultAPI() {
			_classCallCheck(this, QueryResultAPI);
		}

		/**
   * @function QueryResultAPI#getVersion
   * @description Gets the query result version.
   * @private
   *
   * @return {Number} Query result version
   */
		QueryResultAPI.prototype.getVersion = function getVersion() {};

		/**
   * @function QueryResultAPI#hasMoreData
   * @description Checks if the current query result is complete.
   * @private
   *
   * @return {Boolean} true if query result data object includes hasNext or hasPrev equals to true
   */


		QueryResultAPI.prototype.hasMoreData = function hasMoreData() {};

		/**
   * @function QueryResultAPI#getResultItemList
   * @description Gets array of {@link ResultItemAPI}.
   * @public
   *
   * @return {ResultItemAPI[]} Array of {@link ResultItemAPI}
   */


		QueryResultAPI.prototype.getResultItemList = function getResultItemList() {};

		/**
   * @function QueryResultAPI#getResultItem
   * @description Gets result data item with data item unique ID.
   * @private
   *
   * @param {String} resultDataItemID Result data item unique ID
   * @return {ResultItemAPI} {@link ResultItemAPI}
   */


		QueryResultAPI.prototype.getResultItem = function getResultItem() {};

		/**
   * @function QueryResultAPI#getValue
   * @description Gets result data value based on row and column indexes.
   * @public
   *
   * @param {Number} rowIndex Row index of the result data points
   * @param {Number} resultDataItemIndex Data item index to get value in {@link ResultItemAPI}
   * @return {ResultDataValue[] | ResultDataValue} Array of {@link ResultDataValue}
   * @example
   * // Category value
   * [{
   * 	value: 'dataset_csv.Product_line->[Camping Equipment]',
   * 	label: 'Camping Equipment'
   * }]
   * @example
   * // Measure value
   * {
   * 	value: 200
   * }
   */


		QueryResultAPI.prototype.getValue = function getValue() {};

		/**
   * @function QueryResultAPI#getValueIndex
   * @description Given an index in the result, return the index in the resultItem's values where this categorical tuple is found.
   * @private
   *
   * @param {Number} rowIndex The row index (datapoint index)
   * @param {Number} resultDataItemIndex The data item index to get value in {@link ResultItemAPI}
   * @return {Number} A single number representing the index of the tuple.
   * @example The first resultDataItem might be a nested categorical with values like 2004-Cars, 2004-Trucks, 2005-Cars, 2005-Trucks
   * // getValueIndex({pointindex}, 0) would return 2 for any datapoint that contains 2005-Cars for the firstitem.
   * 2
   */


		QueryResultAPI.prototype.getValueIndex = function getValueIndex() {};

		/**
   * @function QueryResultAPI#getDataPointValueList
   * @description Get the data points of the query result object.
   * @private
   *
   * @return {Object[]} An array of data point object
   * @example
   * [{
   * 	pt: [13, 4, {v: 151}, {v: 13834.62}]
   * }]
   */


		QueryResultAPI.prototype.getDataPointValueList = function getDataPointValueList() {};

		/**
   * @function QueryResultAPI#getRowCount
   * @description Gets data row count.
   *
   * @return {Number} Number of rows of data in a query result object.
   */


		QueryResultAPI.prototype.getRowCount = function getRowCount() {};

		/**
   * @function QueryResultAPI#setPropertyValue
   * @description Set a property value.
   * @private
   *
   * @param {String} name Property name
   * @param {String} value Property value
   */


		QueryResultAPI.prototype.setPropertyValue = function setPropertyValue() {};

		/**
   * @function QueryResultAPI#getPropertyValue
   * @description Get a property value.
   * @private
   *
   * @param {String} name Property name
   * @return {String} Property value
   */


		QueryResultAPI.prototype.getPropertyValue = function getPropertyValue() {};

		return QueryResultAPI;
	}();

	/**
  * @private
  * @readonly
  * @description Enumeration of result value types
  * @enum {string}
  * @memberof QueryResultAPI
  */


	QueryResultAPI.VALUE_TYPE = {
		/** Summary value type */
		SUMMARY: 'summary'
	};

	return QueryResultAPI;
});
//# sourceMappingURL=QueryResultAPI.js.map