analytics/webcontent/qs/classes/CUserPreference.js

/****************************************************************
** Licensed Materials - Property of IBM
**
** BI and PM: qs
**
** (C) Copyright IBM Corp. 2001, 2015
**
** US Government Users Restricted Rights - Use, duplication or 
** disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
*****************************************************************/

// Copyright (C) 2008 Cognos ULC, an IBM Company. All Rights Reserved.
// Cognos and the Cognos logo are trademarks of Cognos ULC (formerly Cognos Incorporated) in the United States and/or other countries.  IBM and the IBM logo are trademarks of International Business Machines Corporation in the United States, or other countries, or both.  Other company, product, or service names may be trademarks or service marks of others.










function CUserPreference(sName, bUserOverride)
{
	this.m_sName = null;
	this.m_sDefaultValue = null;
	this.m_sCookieName = null;
	this.m_sDialogValue = null;
	this.m_bUserOverrideAllowed = true;
	this.m_sFormInputName = null;
	this.m_oProperties = new CDictionary();
	
	this.setName(sName);
};


CUserPreference.prototype.setName = function (sName)
{
	this.m_sName = sName;
};
CUserPreference.prototype.getName = function ()
{
	return this.m_sName;
};



CUserPreference.prototype.setDefaultValue = function (sDefaultValue)
{
	this.m_sDefaultValue = sDefaultValue;
};
CUserPreference.prototype.getDefaultValue = function ()
{
	return this.m_sDefaultValue;
};


CUserPreference.prototype.setCookie = function (sValue)
{
	var sType = "qs";
	
	
	var sCookieName = this.getCookieName();
	if (sCookieName && sCookieName.length)
	{
		
		
		if (typeof sValue !== "undefined" && sValue && sValue.length)
		{
			sValue = encodeURIComponent(sValue);
		}
		if (typeof sValue === "undefined" || sValue === null)
		{
			sValue = "";
		}
		
		if (sValue === true)
		{
			sValue = "true";
		}
		if (sValue === false)
		{
			sValue = "false";
		}
		setQSCookie(sType, sCookieName, sValue);
	}	
};



CUserPreference.prototype.getCookie = function ()
{
	var sType = "qs";
	var sReturnCookie = "";
	
	
	var sCookieName = this.getCookieName();
	if (sCookieName && sCookieName.length)
	{
		sReturnCookie = getQSCookie(sType, sCookieName);
	}
	
	
	if (typeof sReturnCookie !== "undefined"  && sReturnCookie && sReturnCookie.length)
	{
		sReturnCookie = decodeURIComponent(sReturnCookie);
	}
	else
	{
		sReturnCookie = "";
	}

	return sReturnCookie;
};



CUserPreference.prototype.setCookieName = function (sCookieName)
{
	this.m_sCookieName = sCookieName;
};


CUserPreference.prototype.getCookieName = function (sCookieName)
{
	var sCookieName = this.m_sCookieName;
	if (!sCookieName)
	{
		sCookieName = "";
	}
	return sCookieName;
};


CUserPreference.prototype.setDefaultValue = function (sValue)
{
	this.m_sDefaultValue = sValue;
};




CUserPreference.prototype.getDefaultValue = function ()
{
	return this.m_sDefaultValue;
};









CUserPreference.prototype.getValue = function ()
{
	
	
	var sValue = "";
	
	if (this.isUserOverrideAllowed())
	{
		sValue = this.getDialogValue();

		if (! this.isSet(sValue))
		{
			
			sValue = this.getCookie();
		}		
	}
	
	if (! this.isSet(sValue))
	{
		sValue = this.getAdvancedServerValue();		
	}	
	if (! this.isSet(sValue))
	{
		sValue = this.getSystemValue();		
	}
	if (! this.isSet(sValue))
	{
		
		sValue = this.getDefaultValue();
	}
	
	
	if (sValue === null || typeof sValue === "undefined")
	{
		sValue = "";
	}
	return sValue;
};



CUserPreference.prototype.setDialogValue = function (sValue)
{
	this.m_sDialogValue = sValue;
};
CUserPreference.prototype.getDialogValue = function (sValue)
{
	return this.m_sDialogValue;
};


CUserPreference.prototype.getSystemValue = function ()
{
	return this.m_sSystemValue;
};
CUserPreference.prototype.setSystemValue = function (sValue)
{
	this.m_sSystemValue = sValue;
};


CUserPreference.prototype.getAdvancedServerValue = function ()
{
	return this.m_sAdvancedServerValue;
};
CUserPreference.prototype.setAdvancedServerValue = function (sValue)
{
	this.m_sAdvancedServerValue = sValue;
};


CUserPreference.prototype.isUserOverrideAllowed = function (sValue)
{
	return this.m_bUserOverrideAllowed;
};
CUserPreference.prototype.setUserOverrideAllowed = function (bValue)
{
	if (typeof bValue === "undefined")
	{
		bValue = false;
	}
	this.m_bUserOverrideAllowed = bValue;
};





CUserPreference.prototype.getFormInputName = function ()
{
	if (this.m_sFormInputName && this.m_sFormInputName.length)
	{
		return this.m_sFormInputName;
	}
	else
	{
		return this.getName();
	}
};
CUserPreference.prototype.setFormInputName = function (sValue)
{
	this.m_sFormInputName = sValue;
};



CUserPreference.prototype.getProperty = function(sPropertyName)
{
	return this.m_oProperties.get(sPropertyName);

};
CUserPreference.prototype.setProperty = function(sPropertyName, sPropertyValue)
{
	this.m_oProperties.add(sPropertyName, sPropertyValue);
};



CUserPreference.prototype.isSet = function (sValue)
{
	return ! (sValue === null || typeof sValue === "undefined" || !sValue.length);
};