Class MQRadiusSearchCriteria

Object
   |
   +--MQObject
         |
         +--MQSearchCriteria
               |
               +--MQRadiusSearchCriteria

class MQRadiusSearchCriteria

extends MQSearchCriteria

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:

- MQLatLng
- MQDistanceUnits

Field Detail

m_MQLatLng

<private> MQLatLng m_MQLatLng

Value to represent the MQLatLng

MQRadiusSearchCriteria

MQRadiusSearchCriteria()

Constructs a new MQRadiusSearchCriteria object.

See:
- MQLatLng
- MQDistanceUnits

getCenter

MQLatLng getCenter()

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

Returns:
The m_MQLatLng object.

getClassName

String getClassName()

Returns the text name of this class.

Returns:
The text name of this class.

getObjectVersion

int getObjectVersion()

Returns the version of this class.

Returns:
The version of this class.

getRadius

Double getRadius(<MQDistanceUnits> lUnits)

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

Parameters:
lUnits - DistanceUnits Miles or KiloMeters

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

loadXml

void loadXml(<String> strXml)

Assigns the xml that relates to this object.

Parameters:
strXml - the xml to be assigned.

saveXml

String saveXml()

Build an xml string that represents this object.

Returns:
The xml string.

setCenter

void setCenter(<MQLatLng> latLng)

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

Parameters:
latLng - the Document to set m_MQLatLng to.

setRadius

void setRadius(<Double> radius, <MQDistanceUnits> lUnits)

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

Parameters:
radius - The radius that this object is to be set to.
lUnits - DistanceUnits Miles or KiloMeters