/*******************************************************************************
** 
** Filename: SCOFunctions.js
**
** File Description: This file contains several JavaScript functions that are 
**                   used by the Sample SCOs contained in the Sample Course.
**                   These functions encapsulate actions that are taken when the
**                   user navigates between SCOs, or exits the Lesson.
**
** Author: ADL Technical Team
**
** Contract Number:
** Company Name: CTC
**
** Design Issues:
**
** Implementation Issues:
** Known Problems:
** Side Effects:
**
** References: ADL SCORM
**
/*******************************************************************************
**
** Concurrent Technologies Corporation (CTC) grants you ("Licensee") a non-
** exclusive, royalty free, license to use, modify and redistribute this
** software in source and binary code form, provided that i) this copyright
** notice and license appear on all copies of the software; and ii) Licensee
** does not utilize the software in a manner which is disparaging to CTC.
**
** This software is provided "AS IS," without a warranty of any kind.  ALL
** EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
** IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-
** INFRINGEMENT, ARE HEREBY EXCLUDED.  CTC AND ITS LICENSORS SHALL NOT BE LIABLE
** FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
** DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES.  IN NO EVENT WILL CTC  OR ITS
** LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT,
** INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER
** CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF
** OR INABILITY TO USE SOFTWARE, EVEN IF CTC  HAS BEEN ADVISED OF THE
** POSSIBILITY OF SUCH DAMAGES.
**
*******************************************************************************/
if (!window.Luminosity)
    window.Luminosity = {};
    
var startDate;
var exitPageStatus;
var scormManager = null;
var API;

function storeAPIRef(APIInstance)
{
    if (APIInstance)
    {
        API = APIInstance;
    }
}

function doLMSInitialize()
{
    if (API){
        var result = API.LMSInitialize("");
        return result;
    }
    else {
        alert("No API found, unable to initialize");
    }
}

function doLMSGetValue(value)
{
    if (API){
        var foundValue = API.LMSGetValue(value);
        return foundValue;
    }
}

function doLMSSetValue(parameter, value)
{
    if (API){
        var setOK = API.LMSSetValue(parameter, value);
        return setOK;
    }
}

function doLMSCommit()
{
    if (API){
        var committed = API.LMSCommit("");
        return committed;
    }
}

function doLMSFinish()
{
    if (API){
        var finished = API.LMSFinish("");
        return finished;
    }
}

function doLMSGetLastError()
{
    if (API){
        var errorCode = API.LMSGetLastError();
        return errorCode;
    }
}

function doGetErrorString(errorCode)
{
    if (API){
        var errorString = API.LMSGetErrorString(errorCode);
        return errorString;
    }
}

function doLMSGetDiagnostic(errorCode)
{
    if (API){
        var diagnostic = API.LMSGetDiagnostic(errorCode);
        return diagnostic;
    }
}

function loadPage() {
   //Gets the singleton ScormManger instance
   var scormManager = Luminosity.ScormManager.getInstance();   
   scormManager.InitializeSCO();     
   exitPageStatus = false;
   startTimer();
}


function startTimer() {    
    startDate = new Date().getTime();    
}

function computeTime() {

    var currentDate;
    var elapsedSeconds;
    var formattedTime;
    
   if ( startDate != 0 ) {
       currentDate = new Date().getTime();
       elapsedSeconds = (currentDate - startDate);
       formattedTime = Luminosity.ScormManager.getInstance().TimeElapsedHHMMSSMS(elapsedSeconds);
   }
   else {
      formattedTime = "00:00:00.0";
   }
   doLMSSetValue( "cmi.core.session_time", formattedTime );
}

function doBack() {

   doLMSSetValue( "cmi.core.exit", "suspend" );

   computeTime();
   exitPageStatus = true;
   
   var result;

   result = doLMSCommit();

	// NOTE: LMSFinish will unload the current SCO.  All processing
	//       relative to the current page must be performed prior
	//		 to calling LMSFinish.   
   
   result = doLMSFinish();

}

function doContinue(status) {

   // Reinitialize Exit to blank
   doLMSSetValue( "cmi.core.exit", "" );

   var mode = doLMSGetValue( "cmi.core.lesson_mode" );

   if ( mode != "review"  &&  mode != "browse" )
   {
      doLMSSetValue( "cmi.core.lesson_status", status );
   }
 
   computeTime();
   exitPageStatus = true;
   
   var result;
   result = doLMSCommit();
	// NOTE: LMSFinish will unload the current SCO.  All processing
	//       relative to the current page must be performed prior
	//		 to calling LMSFinish.   

   result = doLMSFinish();

}

function doQuit(status) {

   computeTime();
   exitPageStatus = true;
      
   var result;

   result = doLMSCommit();
   
   var currentStatus = doLMSGetValue("cmi.core.lesson_status");
   if (currentStatus != "completed")
   {
    result = doLMSSetValue("cmi.core.lesson_status", status);
   }
   
	// NOTE: LMSFinish will unload the current SCO.  All processing
	//       relative to the current page must be performed prior
	//		 to calling LMSFinish.

   result = doLMSFinish();
}

/*******************************************************************************
** The purpose of this function is to handle cases where the current SCO may be 
** unloaded via some user action other than using the navigation controls 
** embedded in the content.   This function will be called every time an SCO
** is unloaded.  If the user has caused the page to be unloaded through the
** preferred SCO control mechanisms, the value of the "exitPageStatus" var
** will be true so we'll just allow the page to be unloaded.   If the value
** of "exitPageStatus" is false, we know the user caused to the page to be
** unloaded through use of some other mechanism... most likely the back
** button on the browser.  We'll handle this situation the same way we 
** would handle a "quit" - as in the user pressing the SCO's quit button.
*******************************************************************************/
function unloadPage( status )
{

	if (exitPageStatus != true)
	{
		doQuit( status );
	}

	// NOTE:  don't return anything that resembles a javascript
	//		  string from this function or IE will take the
	//		  liberty of displaying a confirm message box.
	
}