analytics/webcontent/bi/js/dashboard-analytics/features/dashboard/queryService/api/ResultItemAPI.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 ResultItemAPI
 * @hideconstructor
 * @classdesc API class that is used to work with a result data item.
 * @example queryResult.getResultItemList()[index]
 */
define([], function () {
	var ResultItemAPI = function () {
		function ResultItemAPI() {
			_classCallCheck(this, ResultItemAPI);
		}

		/**
   * @function ResultItemAPI#getDataItemList
   * @description Gets column information in the result data item.
   * @public
   *
   * @return {DataItemAPI[]} Array of DataItemAPI {@link DataItemAPI}
   */
		ResultItemAPI.prototype.getDataItemList = function getDataItemList() {};

		/**
   * @function ResultItemAPI#getId
   * @description Gets the unique ID of the query result data item. It corresponds to the data item unique ID in the query spec.
   * @private
   *
   * @return {String} Data item unique ID
   */


		ResultItemAPI.prototype.getId = function getId() {};

		/**
   * @function ResultItemAPI#getRowCount
   * @description Gets the row count of the corresponding column of the result data item.
   * @public
   *
   * @return {Number} Number of rows in the corresponding column
   */


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

		/**
   * @function ResultItemAPI#getValue
   * @description Gets the value object at the specified rowIndex.
   * @public
   *
   * @param {Number} rowIndex  Index to access the items list.
   * @return {ResultDataValue[]} Value of object array {@link ResultDataValue}
   * @example
   * [{
   * 	value: 'dataset_csv.Product_line->[Camping Equipment]',
   * 	label: 'Camping Equipment'
   * }]
   */


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

		return ResultItemAPI;
	}();

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