Packagecom.mapquest
Classpublic class MQSession
InheritanceMQSession Inheritance MQObjectCollection Inheritance MQObject

Uniquely identifies a MQSession. Maintains the state of the current user's requests. Contains zero or one of the following objects: MapCommand, MapState, DBLayerQueryCollection, FeatureCollection, and CoverageStyle.

See also

MapCommand
MapState
DBLayerQueryCollection
FeatureCollection
CoverageStyle
PrimitiveCollection
AutoMapCovSwitch


Public Properties
 PropertyDefined by
 InheritedCLASS_NAME : String = "MQObject"
[static]
MQObject
Protected Properties
 PropertyDefined by
 InheriteditemXpath : String = "Item"
Value to represent the xpath of items in this collections
MQObjectCollection
 Inheritedm_items : Array
Value to represent collection
MQObjectCollection
 InheritedobjectVersion : Number = 0
Value to represent the version of this object
MQObject
 Inheritedxml : XML = null
MQObject
 Inheritedxpath : String
MQObject
Public Methods
 MethodDefined by
  
Constructs a new MQSession Object.
MQSession
  
add(obj:MQObject):int
Adds a MQObject to the collection.
MQSession
 Inherited
addInteger(integer:int):int
Adds this integer to the array if it has not reached the maximum size.
MQObjectCollection
  
addOne(newElement:MQObject, replacedElement:MQObject):int
Adds an element to this Session object, ensuring that it is the only one of its class type.
MQSession
 Inherited
addString(str:String):int
Adds this string to the array if it has not reached the maximum size.
MQObjectCollection
 Inherited
append(collection:MQObjectCollection):void
Append a collection to this one
MQObjectCollection
 Inherited
contains(item:MQObject):Boolean
Check if the array contains a specific object
MQObjectCollection
 Inherited
get(i:Number):*
Get the item at postion i
MQObjectCollection
 Inherited
getAt(i:Number):*
MQObjectCollection
 Inherited
getById(strId:String):MQObject
Return the object, if it exists, with the id strId
MQObjectCollection
  
getClassName():String
Returns the text name of this class.
MQSession
 Inherited
getItemXpath():String
Returns the m_itemXpath string.
MQObjectCollection
  
Returns the version of this class.
MQSession
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
 Inherited
getSize():int
Get the maximum size.
MQObjectCollection
 Inherited
Accessor method for ValidClassName
MQObjectCollection
 Inherited
Create a copy of this object.
MQObject
 Inherited
MQObject
 Inherited
MQObject
  
Returns true if the specified object is a MapCommand object, false otherwise.
MQSession
  
isValidObject(obj:Object):Boolean
Returns true if the specified object is a valid object for this collection, false otherwise.
MQSession
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
MQSession
 Inherited
readExternal(input:IDataInput):void
MQObject
 Inherited
remove(iIndex:int):*
Remove the item at postion iIndex
MQObjectCollection
 Inherited
removeAll():void
Remove all the items in the array
MQObjectCollection
 Inherited
removeItem(item:MQObject):void
Remove an item by it's pointer.
MQObjectCollection
  
saveXml():XML
Build xml that represents this object.
MQSession
 Inherited
set(i:Number, newO:MQObject):MQObject
Replace an object at position i and return the old object.
MQObjectCollection
 Inherited
setItemXpath(itemXpath:String):void
Sets the m_itemXpath string.
MQObjectCollection
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
 Inherited
setValidClassName(className:String):void
Accessor method for ValidClassName
MQObjectCollection
 Inherited
setXpath(xpath:String):void
Sets the m_xpath object.
MQObject
 Inherited
writeExternal(output:IDataOutput):void
MQObject
Protected Methods
 MethodDefined by
 Inherited
getItems():Array
Accessor method for m_items
MQObjectCollection
 Inherited
getXML():XML
Returns the m_xmlDoc object.
MQObject
 Inherited
getXpath():String
Returns the xpath string.
MQObject
 Inherited
setXML(xml:XML):void
Sets the m_xmlDoc object.
MQObject
Constructor detail
MQSession()constructor
public function MQSession()

Constructs a new MQSession Object.

Method detail
add()method
public override function add(obj:MQObject):int

Adds a MQObject to the collection. Calls addOne(MQObject, null).

Parameters
obj:MQObject — obj The new MQObject to be added to the collection.

Returns
int

See also

null)
addOne()method 
public function addOne(newElement:MQObject, replacedElement:MQObject):int

Adds an element to this Session object, ensuring that it is the only one of its class type. Validates element as being one of object types that is permitted in this Session object. If it is, and there happens to be one of that type of object already present, the new object will replace it.

Parameters
newElement:MQObject — {MQObject} newElement The new element that is to be added to this MQSession object.
 
replacedElement:MQObject — {MQObject} replacedElement The element that was previously in this MQSession object.

Returns
int — index of element that is added.
getClassName()method 
public override function getClassName():String

Returns the text name of this class.

Returns
String — The text name of this class.
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
isMapCommandObject()method 
public function isMapCommandObject(obj:MQObject):Boolean

Returns true if the specified object is a MapCommand object, false otherwise.

Parameters
obj:MQObject — {MQObject} obj The MQObject to be validated.

Returns
Boolean — true if the specified object is a MapComand object, false otherwise.
isValidObject()method 
public override function isValidObject(obj:Object):Boolean

Returns true if the specified object is a valid object for this collection, false otherwise.

Parameters
obj:Object — {MQObject} obj The MQObject to be validated.

Returns
Boolean — Boolean true if the specified object is a valid object for this collection, false otherwise.
loadXml()method 
public override function loadXml(xmlPrm:XML):void

Assigns the xml that relates to this object.

Parameters
xmlPrm:XML — the xml to be assigned.
saveXml()method 
public override function saveXml():XML

Build xml that represents this object.

Returns
XML — The xml.