vds/CCInputParam.js

/**
 * @fileoverview Exposed data type for use outside of VdsClient.
 *               All properties should be exposed to allow use from uncompiled
 *               code.
 *
 * @author kim.simmons@spark-vision.com (Kim Simmons)
 */


goog.provide( 'spv.vds.CCInputParam' );


/**
 * @export
 * @struct
 * @constructor
 */
spv.vds.CCInputParam = function()
{
	/**
	 * @nocollapse
	 * @type {string}
	 */
	this.name = '';

	/**
	 * Possible types: TEXT, CHOICE, NUMBER, BOOLEAN.
	 * @nocollapse
	 * @type {string}
	 */
	this.field_type = '';

	/**
	 * @nocollapse
	 * @type {boolean}
	 */
	this.invalidate_view = false;

	/**
	 * @nocollapse
	 * @type {boolean}
	 */
	this.read_only = false;

	/**
	 * @nocollapse
	 * @type {string}
	 */
	this.value = '';

	/**
	 * @nocollapse
	 * @type {null|string}
	 */
	this.value_hint = null;

	/**
	 * @nocollapse
	 * @type {Object.<string,string>}
	 */
	this.choices = {};
};




/**
 * @nocollapse
 * @param {Object.<string, spv.vds.CCInputParam>} input_params
 * @returns {Object}
 */
spv.vds.CCInputParam.convertCCParamsToObjects = function( input_params )
{
	var raw_params = {};
	for( var n in input_params )
	{
		var ccparam = input_params[n];
		raw_params[ ccparam.name ] = ccparam.value;
	}
	return raw_params;
};