QueryProviderAPI.js 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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 QueryProviderAPI
  10. * @hideconstructor
  11. * @classdesc
  12. */
  13. define([], function () {
  14. var QueryProviderAPI = function () {
  15. function QueryProviderAPI() {
  16. _classCallCheck(this, QueryProviderAPI);
  17. }
  18. /**
  19. * @function QueryProviderAPI#getQuerySpecList
  20. * @description Get an array of objects with query id, type and spec.
  21. * @public
  22. *
  23. * @return {Object[]} An array of objects with query id, type and spec.
  24. * @example
  25. * [{
  26. * 'id': 'layerId1',
  27. * 'type': 'main',
  28. * 'spec': {
  29. * 'projections': []
  30. * ...
  31. * }
  32. * },
  33. * {
  34. * 'id': 'layerId',
  35. * 'type': 'main.minmax',
  36. * 'spec': {
  37. * ...
  38. * }
  39. * }]
  40. */
  41. QueryProviderAPI.prototype.getQuerySpecList = function getQuerySpecList() {};
  42. /**
  43. * @return {String} the type of the provider
  44. */
  45. QueryProviderAPI.prototype.getType = function getType() {};
  46. return QueryProviderAPI;
  47. }();
  48. return QueryProviderAPI;
  49. });
  50. //# sourceMappingURL=QueryProviderAPI.js.map