/**
 * KnowledgePool Integration Engine
 * Functions that contain the content API functions.  This version is a null
 * version that just contains place holders...
 *
 * @author Jez
 * @date 29 April 2001
 * @version 1.00
 */

// -----------------------------------------------------------------------------
// Global Variables
// -----------------------------------------------------------------------------

/** Globally visible variable to show KPIE content API module is loaded */
var KPIE_contentAPI_Loaded = true;

var debug = false;

// -----------------------------------------------------------------------------
// Objects
// -----------------------------------------------------------------------------
/**
 * KPIE_ContentAPI
 * Constructs a new content API object.
 *
 * @param		launchWindow	window that was used to launch the content.
 * @return	new object representing the API object
 */

function KPIE_ContentAPI( launchWindow )
{

	// Properties
	/** Identifer to show the ID of the mapped LMS API */
	this.mappedLMSID = "NULL"
	/** Launch Window */
	this.launchWindow = launchWindow;
	/** Launch URL */
	this.launchURL = this.launchWindow.location.href;
	/** Indicates if there is an LMS supplied API object */
	this.hasLMSAPI = false;

	// Methods
	this.addMapping = KPIE_AddDataModelMap;
	this.findMapping = KPIE_FindMapping;
	this.LMSInitialize = KPIE_LMSInitialize;
	this.LMSFinish = KPIE_LMSFinish;
	this.LMSGetValue = KPIE_LMSGetValue;
	this.LMSSetValue = KPIE_LMSSetValue;
	this.LMSCommit = KPIE_LMSCommit;
	this.LMSGetLastError = KPIE_LMSGetLastError;
	this.LMSGetErrorString = KPIE_LMSGetErrorString;
	this.LMSGetDiagnostic = KPIE_LMSGetDiagnostic;

}

/**
 * KPIE_AddDataModelMap
 * Adds a new data model map object to the mappings array.
 *
 * @param		kpieReference String name of the string in the KPIE data model
 * @param		mappedLMSReference String name of the mapping command in the integrated LMS API
 * @return	void
 */

function KPIE_AddDataModelMap( kpieReference, mappedLMSReference )
{
}

/**
 * KPIE_FindMapping
 * Searches for the data model element that maps to the one passed.
 *
 * @param		kpieElement	string	KPIE data model element
 * @return	string the mapped string.
 */

function KPIE_FindMapping( kpieElement )
{
	return "";
}

/**
 * KPIE_LMSInitialize
 * Initalises communications with the LMS API Adaptor
 *
 * @param	param String should be empty
 * @return	string representing a boolean
 */

function KPIE_LMSInitialize( param )
{
	return "";
  
} 

/**
 * KPIE_LMSFinish
 * Initalises communications with the LMS API Adaptor
 *
 * @param		param	string	this muist be empty
 * @return	string representing a boolean
 */
function KPIE_LMSFinish( param )
{

  return "";
   
} 

/**
 * KPIE_LMSGetValue
 * Gets a value from the LMS.
 *
 * @param		dataElement	string	name of the data to get.  This should conform to the
 *															KPIE data model.
 * @return	string element data
 */
function KPIE_LMSGetValue( dataElement )
{

	return "";
	
 
}

/**
 * KPIE_LMSSetValue
 * Sets a value in the LMS.
 *
 * @param		dataElement	string	name of the data to get.  This should conform to the
 *															KPIE data model.
 * @param		values	string 	one to many arguments representing the data that should be saved and
 *													any extra information such as indexes etc.  The last element is the
 *													actual data.  The reason for the split out is so that an effective
 *													mapping of data can take place.
 * @return	string representing a boolean
 */
function KPIE_LMSSetValue(name) 
{

	return "";

}

/**
 * KPIE_LMSCommit
 * Commits any outstanding values to the LMS.
 *
 * @return	string representing a boolean
 */
function KPIE_LMSCommit()
{
  return "";
   
} 

/**
 * KPIE_LMSGetLastError
 * Gets the error code of the last LMS API error
 *
 * @return	string containing the error code
 */

function KPIE_LMSGetLastError() 
{

	return "";
   
} 

/**
 * KPIE_LMSGetLastErrorString
 * Gets the descriptive error string of errorcode
 *
 * @param		errorCode	String	containing the error code
 * @return	string containing description
 */

function KPIE_LMSGetErrorString(errorCode) 
{
	return "";
} 

/**
 * KPIE_LMSGetDiagnostic
 * Gets the vendor specific error details that corresponds to the error code
 *
 * @param		errorCode	String	containing the error code
 * @return	string containing the error code
 */

function KPIE_LMSGetDiagnostic(errorCode) 
{
	return ""; 
}