joynr.system.DiscoveryProvider.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: Wed Jan 27 16:29:10 CET 2016
 */
(function(undefined){

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

		return missingInImplementation;
	};

	/**
	 * @name DiscoveryProvider
	 * @constructor
	 *
	 * @classdesc
	 * PLEASE NOTE. THIS IS A GENERATED FILE!
	 * 
Generation date: Wed Jan 27 16:29:10 CET 2016
	 * 

The Discovery interface is a joynr internal
	 * interface. This interface is used by libjoynr to add, lookup or
	 * remove provider to joynr discovery. Internally joynr discovery
	 * consists of a centralized discovery directory
	 * (GlobalCapabilitiesDirectory) that is distributed to
	 * all cluster controller (LocalCapabilitiesDirectory).
	 *
	 * @summary Constructor of DiscoveryProvider 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 {DiscoveryProvider} a DiscoveryProvider object to communicate with the joynr infrastructure
	 */
	var DiscoveryProvider = null;
	DiscoveryProvider = function DiscoveryProvider(
		passedImplementation,
		dependencies
	) {
		if (!(this instanceof DiscoveryProvider)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new DiscoveryProvider(
				passedImplementation,
				dependencies);
		}

		var implementation = passedImplementation || {};

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

Adds a provider to the joynr discovery.
		 *
		 * @param {DiscoveryEntry} discoveryEntry -
		 * the new DiscoveryEntry to be added
		 */
		this.add = new dependencies.ProviderOperation(this, implementation.add, "add", [
			{
				inputParameter: [
					{
						name : "discoveryEntry",
						type : "joynr.types.DiscoveryEntry"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
				]
			}
		]);
		/**
		 * @function DiscoveryProvider#lookup
		 * @summary The lookup operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Looks up a providers in the joynr discovery that match
		 * the requested QoS.
		 *
		 * @param {String} domain -
		 * the domain to search for provider
		 * @param {String} interfaceName -
		 * the interface the provider must implement
		 * @param {DiscoveryQos} discoveryQos -
		 * the QoS used for the lookup
		 * @returns {Array.} result -
		 * a list of matching providers
		 */
		/**
		 * @function DiscoveryProvider#lookup
		 * @summary The lookup operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 
method overloading: different call semantics possible
		 * 

Looks up a specific provider in the joynr discovery.
		 *
		 * @param {String} participantId -
		 * the participant ID of the provider to look up
		 * @returns {DiscoveryEntry} result -
		 * the provider matching the participant ID
		 */
		this.lookup = new dependencies.ProviderOperation(this, implementation.lookup, "lookup", [
			{
				inputParameter: [
					{
						name : "domain",
						type : "String"
					},
					{
						name : "interfaceName",
						type : "String"
					},
					{
						name : "discoveryQos",
						type : "joynr.types.DiscoveryQos"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
					{
						name : "result",
						type : "joynr.types.DiscoveryEntry[]"
					}
				]
			},
			{
				inputParameter: [
					{
						name : "participantId",
						type : "String"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
					{
						name : "result",
						type : "joynr.types.DiscoveryEntry"
					}
				]
			}
		]);
		/**
		 * @function DiscoveryProvider#remove
		 * @summary The remove operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Removes a provider from joynr discovery.
		 *
		 * @param {String} participantId -
		 * the participant ID of the provider to remove
		 */
		this.remove = new dependencies.ProviderOperation(this, implementation.remove, "remove", [
			{
				inputParameter: [
					{
						name : "participantId",
						type : "String"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
				]
			}
		]);

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

		this.interfaceName = "system/Discovery";

		this.id = dependencies.uuid();

		return Object.freeze(this);
	};

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