analytics/webcontent/bi/js/dashboard-analytics/features/content/smartsExecution/api/SmartsExecutionAPI.js

'use strict';

var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();

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. 2019
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @class SmartsExecutionAPI
 * @hideconstructor
 * @classdesc
 */
define([], function () {
	var SmartsExecutionAPI = function () {
		function SmartsExecutionAPI() {
			_classCallCheck(this, SmartsExecutionAPI);
		}

		/**
   * @function SmartsExecutionAPI#execute
   * @description Execute a smarts query
   * @returns {Promise} resolves when the execution results are ready
   */
		SmartsExecutionAPI.prototype.execute = function execute() {};

		/**
   * @function SmartsExecutionAPI#getNonAnnotatableReasons
   * 
   * @description Provides reasons why smart annotations can't be applied on a layer. If
   * a layer parameter isn't provided, all layers within the visualization
   * are checked.
   * 
  	 * @typedef {Object} NonAnnotatableReasons
  	 * @property {boolean} allLayers True indicates all layers are non-anotatable.
  	 * @property {Object[]} descriptions Objects describing reasons per layer.
   *
   * @param {string} layer Name of layer to provide non-annotatable reasons.
   *
   * @returns {NonAnnotatableReasons} Non-annotatable reasons of a visualization.
  */
		/**
   * @returns {Promise} 
   */


		SmartsExecutionAPI.prototype.getNonAnnotatableReasons = function getNonAnnotatableReasons() {};

		_createClass(SmartsExecutionAPI, null, [{
			key: 'TARGETS',

			// Enum for the execution targets
			get: function get() {
				return {
					SUGGESTIONS: 'suggestions',
					EXECUTIONS: 'executions'
				};
			}
		}]);

		return SmartsExecutionAPI;
	}();

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