InternalDataQueryExecutionAPI.js 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. "use strict";
  2. function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
  3. /**
  4. * Licensed Materials - Property of IBM
  5. * IBM Business Analytics (C) Copyright IBM Corp. 2019
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class InternalDataQueryExecutionAPI
  10. * @hideconstructor
  11. * @classdesc Data query execution API class.
  12. */
  13. define([], function () {
  14. var InternalDataQueryExecutionAPI = function () {
  15. function InternalDataQueryExecutionAPI() {
  16. _classCallCheck(this, InternalDataQueryExecutionAPI);
  17. }
  18. /**
  19. * @function InternalDataQueryExecutionAPI#queryChanged
  20. * @description Check if query is changed
  21. * @protected
  22. *
  23. * @return true if query spec has changed.
  24. */
  25. InternalDataQueryExecutionAPI.prototype.queryChanged = function queryChanged() {};
  26. /**
  27. * @function InternalDataQueryExecutionAPI#getRawResults
  28. * @description Get the post processed raw query results
  29. * @protected
  30. * @param {String} [id = 'data'] query dataset id
  31. *
  32. * @return {Object} Raw query results
  33. */
  34. InternalDataQueryExecutionAPI.prototype.getRawResult = function getRawResult() {};
  35. /**
  36. * @function InternalDataQueryExecutionAPI#setMinMaxQueryResults
  37. * @description Add a spec with max min value as min max query results to the current query results
  38. * @param {object} spec - includes data items and min max info
  39. * Note - a falsy spec will remove the existing min max query results
  40. * eg.
  41. * {
  42. * reveuneavg: {
  43. * min: 20,
  44. * max: 100,
  45. * columnId: 'revenue'
  46. * }
  47. * }
  48. * @protected
  49. *
  50. * @return {QueryResultsAPI} the current {@link QueryResultsAPI} object
  51. */
  52. InternalDataQueryExecutionAPI.prototype.setMinMaxQueryResults = function setMinMaxQueryResults() {};
  53. return InternalDataQueryExecutionAPI;
  54. }();
  55. return InternalDataQueryExecutionAPI;
  56. });
  57. //# sourceMappingURL=InternalDataQueryExecutionAPI.js.map