| Package | com.esri.baserver.tasks.stdgeographies |
| Class | public final class ReturnStdGeographyTask |
| Inheritance | ReturnStdGeographyTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
This task searches the given standard geography levels for features matching the given location. Only one feature is selected from matching features for every level of geometry. If no matching feature was found for a level of geometry, the value in the corresponding position of the output array will be a pair of empty FeatureID and FeatureName strings.
For example, you can identify standard geography units such as ZIP, Track, or Block Group which contain the given point on the map. A point can be specified in a number of ways—using its geographical coordinates, postal address, or ZIP code.
The result of this task is an array of StdGeographiesFeature items containing IDs and names of features of geography levels matching the given location.
See also
| 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 : Array [read-only]
The last result of executing the Return Standard Geography task. | ReturnStdGeographyTask | ||
| 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 | ||
|---|---|---|---|
ReturnStdGeographyTask(urlOrClient:Object = null)
Creates a new instance of the ReturnStdGeographyTask class. | ReturnStdGeographyTask | ||
Creates a new command encapsulating this task and the given parameters. | ReturnStdGeographyTask | ||
execute(parameters:ReturnStdGeographyParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Return Standard Geography task to the Business Analyst Server HTTP (REST) Service. | ReturnStdGeographyTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = ReturnStdGeography [static] Task name. | ReturnStdGeographyTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:Array [read-only] The last result of executing the Return Standard Geography task. This array contains items of the StdGeographiesFeature type.
public function get lastResult():ArraySee also
| ReturnStdGeographyTask | () | Constructor |
public function ReturnStdGeographyTask(urlOrClient:Object = null)Creates a new instance of the ReturnStdGeographyTask 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) |
See also
| createCommand | () | method |
public function createCommand(parameters:ReturnStdGeographyParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:ReturnStdGeographyParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:ReturnStdGeographyParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Return Standard Geography 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
parameters:ReturnStdGeographyParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = ReturnStdGeographyTask name.