Class deCarta.Mobile.SearchCriteria

Data structure for POI request parameters, used with the deCarta.Mobile.POISearch:execute() method. The structure of the SearchCriteria class is as follows:

 SearchCriteriaObject: {
     queryString: null, //[Not yet defined]
     maximumResponses: int, //Max number of responses that will be returned
     database: string, //Database that will be queried for this search
     sortDirection: string, //Sort order for results ["Ascending", "descending"]
     sortCriteria: string, //Property results will be sorted by ["Distance", "Score"]
     rankCriteria: string, //Property by which results will be ranked [Distance, Score]
     allowAggregates: bool, //Allow Aggregates
     retrieveAll: bool, //retreive all values
     properties: { //Object describing search properties, contains ONE OF:
         CATEGORY: string, //If present, this will perform a category search on this value
         KEYWORD: string, //If present, this will perform a Keyword search on this value
         POIName: string //If present, this will perform a freeform POI Search on this value
     }
     position: deCarta.Mobile.Position, //Position where the search is centered
     radius: deCarta.Mobile.Radius, //Radius of the search
     routeId: int, //if routeId is set, the search will be performed along the route. 
     corridorType: //[Not yet defined]
     map: deCarta.Mobile.Map //Optionally pass Map instead of position+radius

Class Summary
Constructor Attributes	Constructor Name and Description
	deCarta.Mobile.SearchCriteria() Data structure for POI request parameters.

Field Summary
Field Attributes	Field Name and Description
	allowAggregates (bool) Allow Aggregates (default=false)
	corridorType [Not yet defined]
	database (string) Database that will be queried for this search (default='search:decarta:poi')
	map Instead of passing position and radius, you can pass a reference to your map and Position and Radius will be set according to the currently visible area on the map.
	maximumResponses (int) Max number of responses that will be returned (default=10)
	position Position where the search is centered
	properties Object describing search properties Can contain one of the following: CATEGORY : "string".
	queryString
	radius Radius of the search
	rankCriteria (string) Property by which results will be ranked [Distance, Score (default)]
	retrieveAll (bool) retreive all values (default=false)
	routeId (int) if routeId is set, the search will be performed along the route with that ID on the DDS WebServices server.
	sortCriteria (string) Property results will be sorted by ["Distance" (default), "Score"]
	sortDirection (string) Sort order for results ["Ascending" (default), "descending"]

Class Detail

deCarta.Mobile.SearchCriteria()

Data structure for POI request parameters.

See:: deCarta.Mobile.POISearch

Field Detail

allowAggregates

(bool) Allow Aggregates (default=false)

corridorType

[Not yet defined]

database

(string) Database that will be queried for this search (default='search:decarta:poi')

map

Instead of passing position and radius, you can pass a reference to your map and Position and Radius will be set according to the currently visible area on the map.

maximumResponses

(int) Max number of responses that will be returned (default=10)

position

Position where the search is centered

properties

Object describing search properties Can contain one of the following:

CATEGORY : "string".
This will perform a category search.
KEYWORD : "string".
This will perform a Keyword search.
POIName : "string".
This will perform a freeform POI Search.

queryString

radius

Radius of the search

rankCriteria

(string) Property by which results will be ranked [Distance, Score (default)]

retrieveAll

(bool) retreive all values (default=false)

routeId

(int) if routeId is set, the search will be performed along the route with that ID on the DDS WebServices server.

sortCriteria

(string) Property results will be sorted by ["Distance" (default), "Score"]

sortDirection

(string) Sort order for results ["Ascending" (default), "descending"]

Classes

Class deCarta.Mobile.SearchCriteria