Packagecom.mapquest
Classpublic class GeocodeOptions
InheritanceGeocodeOptions Inheritance MQObject

Class for specifying geocode parameters.

See also

MatchType
QualityType

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
  
GeocodeOptions()
Constructs a new GeocodeOptions object
GeocodeOptions
  
getClassName():String
Returns the text name of this class.
GeocodeOptions
  
getCoverageName():String
Gets the name of the coverage that this option applies to
GeocodeOptions
  
getMatchType():MatchType
Returns the m_MatchType object.
GeocodeOptions
  
getMaxMatches():int
Gets the maximum matches to be returned for this object.
GeocodeOptions
  
getObjectVersion():Number
Returns the version of this class.
GeocodeOptions
 Inherited
getProperty(path:String):String
Gets values from xml.
MQObject
  
getQualityType():QualityType
Returns the m_QualityType object.
GeocodeOptions
 Inherited
internalCopy(obj:MQObject):MQObject
Create a copy of this object.
MQObject
 Inherited
internalCopyXML(obj:MQObject):XML
MQObject
 Inherited
internalCopyXMLx(obj:MQObject):String
MQObject
  
loadXml(xmlPrm:XML):void
Assigns the xml that relates to this object.
GeocodeOptions
 Inherited
readExternal(input:IDataInput):void
MQObject
  
saveXml():XML
Build an xml string that represents this object.
GeocodeOptions
  
setCoverageName(newCoverageName:String):void
Sets the name of the coverage that this option applies to
GeocodeOptions
  
setMatchType(matchType:MatchType):void
Sets the m_MatchType.
GeocodeOptions
  
setMaxMatches(nMax:int):void
Sets the maximum matches to be returned for this object.
GeocodeOptions
 Inherited
setProperty(path:String, value:Object):String
Sets values in xml.
MQObject
  
setQualityType(qualityType:QualityType):void
Sets the m_QualityType.
GeocodeOptions
 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
GeocodeOptions()constructor
public function GeocodeOptions()

Constructs a new GeocodeOptions object

See also

MatchType
QualityType
Method detail
getClassName()method
public override function getClassName():String

Returns the text name of this class.

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

Gets the name of the coverage that this option applies to

Returns
String — The name of the coverage that this option applies to
getMatchType()method 
public function getMatchType():MatchType

Returns the m_MatchType object.

Returns
MatchType — The m_MatchType object.
getMaxMatches()method 
public function getMaxMatches():int

Gets the maximum matches to be returned for this object.

Returns
int — The maximum number of matches that are to be returned by the search
getObjectVersion()method 
public override function getObjectVersion():Number

Returns the version of this class.

Returns
Number — The version of this class.
getQualityType()method 
public function getQualityType():QualityType

Returns the m_QualityType object.

Returns
QualityType — The m_QualityType object.
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 an xml string that represents this object.

Returns
XML — The xml string.
setCoverageName()method 
public function setCoverageName(newCoverageName:String):void

Sets the name of the coverage that this option applies to

Parameters
newCoverageName:String — The coverage name
setMatchType()method 
public function setMatchType(matchType:MatchType):void

Sets the m_MatchType.

Parameters
matchType:MatchType — MatchType The object to set m_MatchType to.
setMaxMatches()method 
public function setMaxMatches(nMax:int):void

Sets the maximum matches to be returned for this object.

Parameters
nMax:int — nMax The maximum number of matches that are to be returned by the search.
setQualityType()method 
public function setQualityType(qualityType:QualityType):void

Sets the m_QualityType.

Parameters
qualityType:QualityType — QualityType The object to set m_QualityType to.