Packagecom.esri.baserver.tasks.businessessearch
Classpublic final class SelectLocationsTask
InheritanceSelectLocationsTask Inheritance BAServerTask Inheritance BATask Inheritance AbstractTask Inheritance flash.events.EventDispatcher

The Select Locations task returns business locations matching the given search criteria.

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.

ExampleDescription
[ "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.

View the examples



Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAServerTask
 Inheritedconcurrency : String
Value that indicates how to handle multiple calls to the same task.
AbstractTask
 InheriteddisableClientCaching : 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
 InheritedisFullErrorMessage : 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
 InheritedproxyURL : String
The URL to proxy the request through.
AbstractTask
 InheritedrequestTimeout : Number
The request timeout in seconds.
AbstractTask
 InheritedshowBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing.
AbstractTask
 Inheritedtoken : String
Token for accessing a secure task.
AbstractTask
 InheritedtokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires.
BATask
 Inheritedurl : String
URL of the task.
AbstractTask
Public Methods
 MethodDefined 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
Events
 Event Summary Defined By
 InheritedThe fault event is dispatched when an asynchronous execution of a Community Analyst Task fails.BATask
 InheritedThe taskCompleted event is dispatched when an asynchronous execution of a Community Analyst Task successfully completes.BATask
Public Constants
 ConstantDefined By
  name : String = SelectLocations
[static] Task name.
SelectLocationsTask
Property Detail
lastResultproperty
lastResult:FeatureSet  [read-only]

The last result of executing the Select Locations task. This array contains strings.


Implementation
    public function get lastResult():FeatureSet
Constructor Detail
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.

Parameters
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

Method Detail
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.

Returns
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 — ...

Returns
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.

Returns
AsyncToken — Asynch token associated with the response.
Constant Detail
nameConstant
public static const name:String = SelectLocations

Task name.

Examples
ActionScript to execute a Select Locations task:
     
     // Specify geography levels filter.
     var geographyLevelsFilter:Array = [ "CA", "Red", "*" ];
     
     selectLocationsTask.execute(geographyLevelsFilter, new Responder(resultHandler, faultHandler));