analytics/webcontent/qs/classes/CFeatureRegistry.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.




var FEATURE_IS_NOT_FEATURE = -3;
var FEATURE_ALREADY_REGISTERED = -2;
var FEATURE_NOT_REGISTERED = -1;
var FEATURE_FAILED_REGISTRATION = 0;
var FEATURE_REGISTRATION_SUCCEEDED = 1;
var FEATURE_FAILED_DEREGISTRATION = -4;
var FEATURE_DEREGISTRATION_SUCCEEDED = 2;
var FEATURE_REGISTERED_STATE = "registered";
var FEATURE_DEREGISTERED_STATE = "deregistered";

function CFeatureRegistry()
{
	this.m_aRegisteredFeatures = new Array();
	this.m_aRegisteredFeaturesLaunchableStatus = new Array();
	this.m_aUnregisteredFeatures = new Array();
};

CFeatureRegistry.prototype.register = function (sFeatureName, oFeatureObject, bCanBeLaunched)
{
	if (this.isRegistered(sFeatureName) === true)
	{
		return FEATURE_ALREADY_REGISTERED;
	}
	
	try
	{
		if (oFeatureObject instanceof AFeatureObject)
		{
			oFeatureObject.m_sFeatureState = FEATURE_REGISTERED_STATE;
			this.m_aRegisteredFeatures[sFeatureName] = oFeatureObject;
			this.m_aRegisteredFeaturesLaunchableStatus[sFeatureName] = bCanBeLaunched;
		}
		else
		{
			this.addToUnregisteredList(sFeatureName, oFeatureObject);
			return FEATURE_IS_NOT_FEATURE;
		}
	}
	catch (e)
	{
		return FEATURE_FAILED_REGISTRATION;
	}
	return FEATURE_REGISTRATION_SUCCEEDED;
};

CFeatureRegistry.prototype.addToUnregisteredList = function (sFeatureName, oFeatureObject)
{
	try
	{
		this.m_aUnregisteredFeatures[sFeatureName] = oFeatureObject;
	}
	catch (e)
	{
		return false;
	}
	return true;
};

CFeatureRegistry.prototype.isRegistered = function (sFeatureName)
{
	if (typeof this.m_aRegisteredFeatures[sFeatureName] != "undefined")
	{
		if (this.m_aRegisteredFeatures[sFeatureName] instanceof AFeatureObject)
		{
			return true;
		}
		else
		{
			this.deregister(sFeatureName, true);
		}
	}
	return false;
};

CFeatureRegistry.prototype.getAllRegisteredFeatures = function ()
{
	return this.m_aRegisteredFeatures;
};

CFeatureRegistry.prototype.getAllUnregisteredFeatures = function ()
{
	return this.m_aUnregisteredFeatures;
};

CFeatureRegistry.prototype.getRegisteredFeature = function (sFeatureName)
{
	if (this.isRegistered(sFeatureName) === false)
	{
		return FEATURE_NOT_REGISTERED;
	}
	
	try
	{
		return this.m_aRegisteredFeatures[sFeatureName];
	}
	catch (e)
	{
		return FEATURE_FAILED_REGISTRATION;
	}
};

CFeatureRegistry.prototype.isFeatureLaunchable = function (sFeatureName)
{
	if (this.isRegistered(sFeatureName) === false)
	{
		return false;
	}
	
	try
	{
		return this.m_aRegisteredFeaturesLaunchableStatus[sFeatureName];
	}
	catch (e)
	{
		return false;
	}
};

CFeatureRegistry.prototype.deregister = function (sFeatureName, bForceDeregistration)
{
	if (!bForceDeregistration && this.isRegistered(sFeatureName) === false)
	{
		return FEATURE_NOT_REGISTERED;
	}
	
	try
	{
		this.m_aRegisteredFeatures[sFeatureName].m_sFeatureState = FEATURE_DEREGISTERED_STATE;
		this.addToUnregisteredList(sFeatureName, this.getRegisteredFeature(sFeatureName));
		this.m_aRegisteredFeatures = deleteArrayEntry(this.m_aRegisteredFeatures, sFeatureName);
		this.m_aRegisteredFeaturesLaunchableStatus = deleteArrayEntry(this.m_aRegisteredFeaturesLaunchableStatus, sFeatureName);
	}
	catch (e)
	{
		return FEATURE_FAILED_DEREGISTRATION;
	}
	return FEATURE_DEREGISTRATION_SUCCEEDED;
};