/*
 * $Log: mw_lib_xml_action_showtimes_venuessessionsandtitlesofregion.js,v $
 * Revision 1.1  2007/11/22 06:50:59  shane
 * metawrap js file for venues, sessions & titles of region
 *
 */

/*! \page mw_javascript_lib_xml_action_xmlvault MetaWrap - JavaScript - XML - Action - Showtimes
 *
 * \subsection mw_javascript_lib_xml_action_xmlvault Overview
 *
 */

//alert("$Id: mw_lib_xml_action_showtimes_venuessessionsandtitlesofregion.js,v 1.1 2007/11/22 06:50:59 shane Exp $");

/*! \defgroup mw_javascript_lib_xml_action_xmlvault  MetaWrap - JavaScript - XML - Action - Showtimes
 *@{
 *
 */

// Ensure we have the namespace we need
MwUse("MetaWrap","mw_lib.js");
MwUse("MetaWrap.XML","mw_lib_xml.js");
MwUse("MetaWrap.XML.Action","mw_lib_xml_action.js");

/*! @name  MetaWrap.XML.Action.Showtimes */
//@{

/*!
    @namespace  MetaWrap.XML.Action.Showtimes
    @brief      Register the namespace
*/

//this line (below) is needed in a standalone js file
//it is not needed when the file /js/mw/mw_lib_xml_action_showtimes.js is loaded first
//MetaWrap.XML.Action.Showtimes = {};


/*!
    @class      MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion = function(p_region,p_dayoffset)
    @param      p_region region id eg 3
    @param      p_dayoffset number of days we want to sessions for 0 = Today (max 7)
    @return     void
    @brief
    @author     James Mc Parlane
    @date       8 May 2006

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion = function(p_region,p_dayoffset)
{
	this.m_action = {};
	this.m_action.m_venuessessionsandtitlesofregion = { m_region:p_region,m_dayoffset:p_dayoffset};
}


/*!
    @class      MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response = function()
    @return     The response object
    @brief
    @author     James Mc Parlane
    @date       8 May 2006

    This needs to have m_status as this is returned by default;

    -_results should match what is in inside the returned xml (response/venuessessionsandtitlesofregion/results)

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response = function()
{

    this.m_results = new MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.results();
}

/*!
	@class      Search.Command.Search.Response = function()
	@return     void
	@brief      Implemenets Class that contains response of a cities
	@author     James Mc Parlane
	@date       8 May 2006


*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.prototype.response = function()
{
    this.m_response = {};
    this.m_response.m_venuessessionsandtitlesofregion = new MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response();
    return this;
}



/*!
    @class      MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.results = function()
    @return     void
    @brief		Represents what is returned inside of response/venuessessionsandtitlesofregion/results
    @author     James Mc Parlane
    @date       8 May 2006

    Most strings and simple objects can be handled by default.

    A simple object contains no arrays

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.results = function()
{

    this.m_venues = []
}



/*!
    @function   MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.results.prototype.m_venues_create = function()
    @return     void
    @brief		This is the creator for m_venues for this class
    @author     James Mc Parlane
    @date       8 May 2006

	This needs to create a new venue and add it to the m_venues array

	A venue contains an array of titles (m_title) so we need to return it as an object, otherwise we could just create
	an empty Object by "var l_object = {};"

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.results.prototype.m_venues_create = function()
{

	var l_object = new MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.venue();
	this.m_venues[this.m_venues.length] = l_object;
	return l_object;
}




/*!
    @class      MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.venue = function()
    @return     void
    @brief		Represents the XML returned for a venue
    @author     James Mc Parlane
    @date       8 May 2006

    Most strings and simple objects can be handled by default - everything is assumed to be a string unless defined.

    A simple object contains no arrays

    Because m_id is an integer and we want it to be number in JavaScript - we define it

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.venue = function()
{
	 this.m_id = 0;
     //this.m_address = {};
     this.m_titles = [];
}


/*!
    @function   MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.venue.prototype.m_titles_create = function()
    @return     void
    @brief		This is the creator for m_titles for this class
    @author     James Mc Parlane
    @date       8 May 2006

	This needs to create a new title and add it to the m_titles array

	A title contains an array of sessions (m_sessions) so we need to return it as an object, otherwise we could just create
	an empty Object by "var l_object = {};"

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.venue.prototype.m_titles_create = function()
{

	//alert("m_title_create");

	var l_object = new MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.title();

	this.m_titles[this.m_titles.length] = l_object;
	return l_object;
}


/*!
    @class      MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.title = function()
    @return     void
    @brief		Represents the XML returned for a venue
    @author     James Mc Parlane
    @date       8 May 2006

    Most strings and simple objects can be handled by default.

    A simple object contains no arrays


*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.title = function()
{

     this.m_sessions = [];
}

/*!
    @function   MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.title.prototype.m_sessions_create = function()
    @return     void
    @brief		This is the creator for m_sessions for this class
    @author     James Mc Parlane
    @date       8 May 2006

	This needs to create a new session and add it to the m_titles array

	As a session contains no arrays - we can just add a {} and be done with it

*/
MetaWrap.XML.Action.Showtimes.venuessessionsandtitlesofregion.Response.title.prototype.m_sessions_create = function()
{

	//alert("m_sessions_create");

	var l_object =  {};

	this.m_sessions[this.m_sessions.length] = l_object;
	return l_object;
}


/*!
 *@} endgroup mw_javascript_lib_xml_action_xmlvault MetaWrap - JavaScript - XML - Action - Showtimes
 */

/*!
 *@} end of MetaWrap.XML.Action.Showtimes
 */