analytics/webcontent/bi/js/gemini/features/common/properties/api/PropertiesAPI.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. 2019, 2020
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @interface PropertiesAPI
 * @hideconstructor
 * @classdesc API class that is used to obtain the list of properties and property layouts, and manage provider registrations.
 * @example dashboard.getFeature('Properties')
 */
define([], function () {
	var PropertiesAPI = function () {
		function PropertiesAPI() {
			_classCallCheck(this, PropertiesAPI);
		}

		/**
   * @function PropertiesAPI#getPropertyLayoutList
   * @description Returns the list of all property layouts.
   * @return {Object[]}
   */
		PropertiesAPI.prototype.getPropertyLayoutList = function getPropertyLayoutList() {};

		/**
   * @function PropertiesAPI#getPropertyList
   * @description Returns the list of all properties.
   * @return {Object[]}
   */


		PropertiesAPI.prototype.getPropertyList = function getPropertyList() {};

		/**
   * @function PropertiesAPI#registerProvider
   * @description Registers a provider as a properties provider.
         * @param {PropertiesProviderAPI} provider Properties provider to register and contribute properties
   */


		PropertiesAPI.prototype.registerProvider = function registerProvider() {};

		/**
   * @function PropertiesAPI#deregisterProvider
   * @description Deregisters a provider as a properties provider.
         * @param {PropertiesProviderAPI} provider Properties provider to deregister and remove properties
   */


		PropertiesAPI.prototype.deregisterProvider = function deregisterProvider() {};

		/**
   * for debug usage
   */


		PropertiesAPI.prototype.getProviderPropertyNameList = function getProviderPropertyNameList() {};

		return PropertiesAPI;
	}();

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