QueryDataItemAPI.js 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. 'use strict';
  2. function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
  3. function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
  4. function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
  5. /**
  6. * Licensed Materials - Property of IBM
  7. * IBM Business Analytics (C) Copyright IBM Corp. 2019
  8. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  9. */
  10. /**
  11. * @class QueryDataItemAPI
  12. * @hideconstructor
  13. * @classdesc API class used to access data items of the query
  14. */
  15. define(['../../../../api/DataItemAPI'], function (DataItemAPI) {
  16. var QueryDataItemAPI = function (_DataItemAPI) {
  17. _inherits(QueryDataItemAPI, _DataItemAPI);
  18. function QueryDataItemAPI() {
  19. _classCallCheck(this, QueryDataItemAPI);
  20. return _possibleConstructorReturn(this, _DataItemAPI.apply(this, arguments));
  21. }
  22. /**
  23. * @function QueryDataItemAPI#getProjected
  24. * @description Determine whether the data item is projected in the query
  25. * @public
  26. * @return {Boolean} true if the data item is projected in the query, otherwise false
  27. */
  28. QueryDataItemAPI.prototype.getProjected = function getProjected() {};
  29. /**
  30. * @function QueryDataItemAPI#getProjected
  31. * @description Determine whether the data item is projected in the query
  32. * @public
  33. * @param {Boolean} true if the data item is projected in the query, otherwise false
  34. */
  35. QueryDataItemAPI.prototype.setProjected = function setProjected() {};
  36. /**
  37. * @function QueryDataItemAPI#getCommandList
  38. * @description Get the list of query data item commands
  39. * @public
  40. * @return {QueryDataItemCommand[]} array of query data item commands
  41. */
  42. QueryDataItemAPI.prototype.getCommandList = function getCommandList() {};
  43. /**
  44. * @function QueryDataItemAPI#addCommand
  45. * @description Add a query command to the data item.
  46. * @public
  47. * @param {QueryDataItemCommand} command The query data item command
  48. */
  49. QueryDataItemAPI.prototype.addCommand = function addCommand() {};
  50. /**
  51. * @function QueryDataItemAPI#setType
  52. * @description set the actual type of the query data item
  53. * @public
  54. * @return {String} dataItem type
  55. */
  56. QueryDataItemAPI.prototype.setType = function setType() {};
  57. return QueryDataItemAPI;
  58. }(DataItemAPI);
  59. return QueryDataItemAPI;
  60. });
  61. //# sourceMappingURL=QueryDataItemAPI.js.map