Packagecom.mapquest
Classpublic class RadiusSearchCriteria
InheritanceRadiusSearchCriteria Inheritance SearchCriteria Inheritance MQObject

Defines the criteria for a radius search. The radius to be searched is defined by the latitude/longitude of the Center and the radius of the circle.

See also

LatLng
DistanceUnits


Public Properties
 PropertyDefined by
 InheritedCLASS_NAME : String = "MQObject"
[static]
MQObject
Protected Properties
 PropertyDefined by
 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 RadiusSearchCriteria object.
RadiusSearchCriteria
  
Returns the Center (latitude/longitude) of the circle which defines the extent of the search area.
RadiusSearchCriteria
  
getClassName():String
Returns the text name of this class.
RadiusSearchCriteria
 Inherited
Gets the data member of this object which indicates the maximum number of matches that are to be returned by the search.
SearchCriteria
  
Returns the version of this class.
RadiusSearchCriteria
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getRadius(lUnits:DistanceUnits):Number
Returns the radius of the circle which defines the extent of the search area.
RadiusSearchCriteria
 Inherited
Create a copy of this object.
MQObject
 Inherited
MQObject
 Inherited
MQObject
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
RadiusSearchCriteria
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build xml that represents this object.
RadiusSearchCriteria
  
setCenter(latLng:LatLng):void
Sets the latitude and longitude values of the Center point of the circle which defines the extent of the search area.
RadiusSearchCriteria
 Inherited
setMaxMatches(nMax:int):void
Sets the data member of this object which indicates the maximum number of matches that are to be returned by the search.
SearchCriteria
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setRadius(radius:Number, lUnits:DistanceUnits = null):void
Sets the radius of the circle which defines the extent of the search area.
RadiusSearchCriteria
 Inherited
setXpath(xpath:String):void
Sets the m_xpath object.
MQObject
 Inherited
writeExternal(output:IDataOutput):void
MQObject
Protected Methods
 MethodDefined by
 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
RadiusSearchCriteria()constructor
public function RadiusSearchCriteria()

Constructs a new RadiusSearchCriteria object.

Method detail
getCenter()method
public function getCenter():LatLng

Returns the Center (latitude/longitude) of the circle which defines the extent of the search area.

Returns
LatLng — The m_MQLatLng object.
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.
getRadius()method 
public function getRadius(lUnits:DistanceUnits):Number

Returns the radius of the circle which defines the extent of the search area.

Parameters
lUnits:DistanceUnits — lUnits DistanceUnits Miles or KiloMeters

Returns
Number — The radius of the circle which defines the extent of the search area.
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.
setCenter()method 
public function setCenter(latLng:LatLng):void

Sets the latitude and longitude values of the Center point of the circle which defines the extent of the search area.

Parameters
latLng:LatLng — Document to set m_MQLatLng to.
setRadius()method 
public function setRadius(radius:Number, lUnits:DistanceUnits = null):void

Sets the radius of the circle which defines the extent of the search area.

Parameters
radius:Number — radius The radius that this object is to be set to.
 
lUnits:DistanceUnits (default = null) — lUnits DistanceUnits Miles or KiloMeters