joynr.system.LoggingProvider.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
There is a newer version: 1.4.0
/*
 * PLEASE NOTE. THIS IS A GENERATED FILE!
 * Generation date: Tue Nov 22 17:28:04 CET 2016
 */
(function(undefined){

	var checkImpl = function() {
		var missingInImplementation = [];
		if (! this.log.checkOperation())  missingInImplementation.push("Operation:log");

		return missingInImplementation;
	};

	/**
	 * @name LoggingProvider
	 * @constructor
	 *
	 * @classdesc
	 * PLEASE NOTE. THIS IS A GENERATED FILE!
	 * 
Generation date: Tue Nov 22 17:28:04 CET 2016
	 * 

"The logging interface is implemented by log4j and
	 * log4javascript appenders. Do not use directly"
	 *
	 * @summary Constructor of LoggingProvider object
	 *
	 * @param {Object} [implementation] the implementation of the provider
	 * @param {Object} [implementation.ATTRIBUTENAME] the definition of attribute implementation
	 * @param {Function} [implementation.ATTRIBUTENAME.set] the getter function with the
	 *     signature "function(value){}" that stores the given attribute value
	 * @param {Function} [implementation.ATTRIBUTENAME.get] the getter function with the
	 *     signature "function(){}" that returns the current attribute value
	 * @param {Function} [implementation.OPERATIONNAME] the operation function
	 * @param {Object} [implementation.EVENTNAME] the definition of the event implementation
	 *
	 * @returns {LoggingProvider} a LoggingProvider object to communicate with the joynr infrastructure
	 */
	var LoggingProvider = null;
	LoggingProvider = function LoggingProvider(
		passedImplementation,
		dependencies
	) {
		if (!(this instanceof LoggingProvider)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new LoggingProvider(
				passedImplementation,
				dependencies);
		}

		var implementation = passedImplementation || {};

		// defining provider members
		/**
		 * @function LoggingProvider#log
		 * @summary The log operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

log a number of events
		 *
		 * @param {Object} settings the arguments object for this function call
		 * @param {Array.} settings.logEvents -
		 * The list of events to be logged
		 */
		this.log = new dependencies.ProviderOperation(this, implementation.log, "log", [
			{
				inputParameter: [
					{
						name : "logEvents",
						type : "joynr.system.JoynrLogEvent[]",
						javascriptType : "Array"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
				]
			}
		]);

		Object.defineProperty(this, 'checkImplementation', {
			enumerable: false,
			configurable: false,
			writable: false,
			value: checkImpl
		});

		this.interfaceName = "system/Logging";

		return Object.freeze(this);
	};

	/**
	 * @name LoggingProvider#MAJOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MAJOR_VERSION of the provider is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(LoggingProvider, 'MAJOR_VERSION', {
		enumerable: false,
		configurable: false,
		writable: false,
		readable: true,
		value: 0
	});
	/**
	 * @name LoggingProvider#MINOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MINOR_VERSION of the provider is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(LoggingProvider, 'MINOR_VERSION', {
		enumerable: false,
		configurable: false,
		writable: false,
		readable: true,
		value: 0
	});

	// AMD support
	if (typeof define === 'function' && define.amd) {
		define("joynr/system/LoggingProvider", [
			"joynr/system/JoynrLogLevel",
			"joynr/system/JoynrLoggedError",
			"joynr/system/JoynrLogEvent",
			"joynr/system/JoynrLoggingContextTag"
			], function () {
				return LoggingProvider;
			}
		);
	} else if (typeof exports !== 'undefined' ) {
		if ((module !== undefined) && module.exports) {
			require("../../joynr/system/JoynrLogLevel");
			require("../../joynr/system/JoynrLoggedError");
			require("../../joynr/system/JoynrLogEvent");
			require("../../joynr/system/JoynrLoggingContextTag");
			exports = module.exports = LoggingProvider;
		}
		else {
			// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
			exports.LoggingProvider = LoggingProvider;
		}
	} else {
		window.LoggingProvider = LoggingProvider;
	}
})();