Package | com.esri.baserver.tasks.businessessearch |
Class | public final class SelectLocationsTask |
Inheritance | SelectLocationsTask BAServerTask BATask AbstractTask flash.events.EventDispatcher |
A business location is specified with a list of names of sites of standard geography levels.
For USA, a business location is identified with sites from 3 geography levels—US.States, US.Counties, and US.ZIP5.
The geographyLevelsFilter
parameter specifies an array of search criteria
whose number is equal to the number of geography levels identifying a business location and whose order is
from top to bottom. For example, the geography levels filter for USA should contain 3 strings for search in
State abbreviation, County name, and ZIP5 code fields of business locations. The wildcard *
can be substituted instead of any search string. It means that the corresponding field of a business location
is ignored in the search.
Example | Description |
---|---|
[ "CA", "Redlands", "92373" ] | Searches for State field containing "CA", County field containing "Redlands", and ZIP5 field containing "92373" substring. |
[ "CA", "Red", "*" ] | Searches for State field containing "CA" and County field containing "Red" substring. ZIP5 field value is any. |
[ "CA", "*", "9237" ] | Searches for State field containing "CA" and ZIP5 field containing "9237" substring. County field value is any. |
[ "*", "Red", "*" ] | Searches for County field containing "Red" substring. State and ZIP5 field values are any. |
[ "*", "*", "*" ] | Returns all available business locations. |
NOTE 1: The search is case insensitive.
NOTE 2: Do not use the wildcard symbol *
together with ordinary symbols in one search criterion.
In this case, the wildcard symbol will be interpreted as an ordinary symbol and an empty table of business locations
will be returned.
The result of this task is a FeatureSet
object containing attributes of business locations selected.
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BAServerTask | ||
concurrency : String
Value that indicates how to handle multiple calls to the same task. | AbstractTask | ||
disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from
being loaded from the browser's cache. | AbstractTask | ||
isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false). | BAServerTask | ||
lastResult : FeatureSet [read-only]
The last result of executing the Select Locations task. | SelectLocationsTask | ||
proxyURL : String
The URL to proxy the request through. | AbstractTask | ||
requestTimeout : Number
The request timeout in seconds. | AbstractTask | ||
showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | AbstractTask | ||
token : String
Token for accessing a secure task. | AbstractTask | ||
tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | BATask | ||
url : String
URL of the task. | AbstractTask |
Method | Defined By | ||
---|---|---|---|
SelectLocationsTask(urlOrClient:Object = null)
Creates a new instance of the SelectLocationsTask class. | SelectLocationsTask | ||
createCommand(geographyLevelsFilter:Array, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters. | SelectLocationsTask | ||
createParameters(geographyLevelsFilter:Array):IBATaskParameters [static]
Creates parameters of this task in order to execute it with a generic or batch task. | SelectLocationsTask | ||
execute(geographyLevelsFilter:Array, responder:IResponder):AsyncToken
Sends a request for executing a Select Locations task to the Business Analyst Server HTTP (REST) Service. | SelectLocationsTask |
Constant | Defined By | ||
---|---|---|---|
name : String = SelectLocations [static] Task name. | SelectLocationsTask |
lastResult | property |
lastResult:FeatureSet
[read-only] The last result of executing the Select Locations task. This array contains strings.
public function get lastResult():FeatureSet
SelectLocationsTask | () | Constructor |
public function SelectLocationsTask(urlOrClient:Object = null)
Creates a new instance of the SelectLocationsTask class.
A new task can be constructed in two ways: as a task sharing a BAServerClient type instance
with other tasks (the urlOrClient
parameter has the BAServerClient type) or
as a standalone task encapsulating its own client.
The base URL to the Business Analyst Server HTTP Service looks as follows:
http://{host}:{port}/ArcGIS/baserver/REST/services/DefaultMap/BAServer
The {host}
and {port}
parameters in this URL should be substituted with
valid Business Analyst Server host name and port, respectively.
urlOrClient:Object (default = null ) — A variable containing either Business Analyst Server HTTP Service base URL string or an
instance of the BAServerClient class.
|
See also
createCommand | () | method |
public function createCommand(geographyLevelsFilter:Array, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
Parameters
geographyLevelsFilter:Array — ...
| |
commandName:String (default = null ) — Command name.
|
BACommand — A new command.
|
createParameters | () | method |
public static function createParameters(geographyLevelsFilter:Array):IBATaskParameters
Creates parameters of this task in order to execute it with a generic or batch task.
Parameters
geographyLevelsFilter:Array — ...
|
IBATaskParameters — Parameters of this task.
|
See also
execute | () | method |
public function execute(geographyLevelsFilter:Array, responder:IResponder):AsyncToken
Sends a request for executing a Select Locations task to the Business Analyst Server HTTP (REST) Service.
A response can be received in two ways—in an optional
responder
object passed in parameters
of this method and/or in listeners of fault
and taskCompleted
events registered for this task.
The responder is notified first when a response is received and parsed.
Its fault
method receives a parameter of the FaultEvent
type and its
result
method receives a parameter of the BATaskCompletedEvent
type
whose result
property contains the result object.
After that the received event is dispatched to listeners of this task.
If a response is succesfully received and parsed, the result is assigned to the
lastResult
property of this task.
Parameters
geographyLevelsFilter:Array — ...
| |
responder:IResponder — A responder to call on result or fault.
|
AsyncToken — Asynch token associated with the response.
|
name | Constant |
public static const name:String = SelectLocations
Task name.
// Specify geography levels filter. var geographyLevelsFilter:Array = [ "CA", "Red", "*" ]; selectLocationsTask.execute(geographyLevelsFilter, new Responder(resultHandler, faultHandler));