analytics/webcontent/bi/js/content_apps/authoring/OutputHandler.js

/*
 *+------------------------------------------------------------------------+
 *| Licensed Materials - Property of IBM
 *| IBM Cognos Products: Content-Apps
 *| (C) Copyright IBM Corp. 2018
 *|
 *| US Government Users Restricted Rights - Use, duplication or disclosure
 *| restricted by GSA ADP Schedule Contract with IBM Corp.
 *+------------------------------------------------------------------------+
 */
define([
	'bi/commons/ui/core/Class'
], function (Class) {
	'use strict';

	var OutputHandler = Class.extend({

		/**
		 * Called by constructor.
		 * @param {object} options
		 */
		init: function (options) {
			void (options);
		},

		/**
		 * Returns the relative priority of this handler: the higher the number the higher the priority.
		 * So if two handlers can execute the output, the one with the higher priority will be chosen
		 * @returns {number} the relative priority of this handler
		 */
		getPriority: function() {
			return -1;
		},

		/**
		 * Returns a boolean to indicate if it can handle the output, given the options
		 * @param {object} options
		 * @param {object} options.glassContext
		 * @param {object} options.output
		 * @param {object} options.report
		 * @returns {boolean} 
		 */
		canExecute: function(options) {
			void(options);
			return false;
		},

		/**
		 * Returns a promise wrapped boolean to indicate if it handled the output, given the options
		 * @param {object} options
		 * @param {object} options.glassContext
		 * @param {object} options.output
		 * @param {object} options.report
		 * @returns {object} Promise
		 */
		execute: function(options) {
			void(options);
			return Promise.reject(new Error('Function not implemented'));
		}

	});

	return OutputHandler;

});