Package | com.esri.bao.tasks.stdgeographies |
Class | public class ReturnStdGeographyTask |
Inheritance | ReturnStdGeographyTask BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
This task searches in 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, 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. | BAOnlineTask | ||
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 | ||
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 Community Analyst HTTP (REST) Service. | ReturnStdGeographyTask |
Method | Defined By | ||
---|---|---|---|
resultHandler(asyncToken:AsyncToken):void [override] | ReturnStdGeographyTask |
Constant | Defined By | ||
---|---|---|---|
name : String = report/ReturnStdGeography [static] Task name. | ReturnStdGeographyTask |
lastResult | property |
lastResult: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():Array
See 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 BAOnlineClient type instance
with other tasks (the urlOrClient
parameter has the BAOnlineClient type) or
as a standalone task encapsulating its own client.
The base URL to the Community Analyst REST Service looks as follows:
http://{host}:{port}
The {host}
and {port}
parameters in this URL should be substituted with
valid Community Analyst host name and port, respectively.
If urlOrClient
is null, the "http://baoapi.esri.com" value is assigned as the base URL.
urlOrClient:Object (default = null ) — A variable containing either Community Analyst HTTP Service base URL string or an
instance of the BAOnlineClient class.
|
See also
createCommand | () | method |
public function createCommand(parameters:ReturnStdGeographyParameters, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
Parameters
parameters:ReturnStdGeographyParameters — Parameters of a task to be executed.
| |
commandName:String (default = null ) — Command name.
|
BACommand — A new command.
|
execute | () | method |
public function execute(parameters:ReturnStdGeographyParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Return Standard Geography task to the Community Analyst 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 ) — A responder to call on result or fault.
|
AsyncToken — Asynch token associated with the response.
|
resultHandler | () | method |
override protected function resultHandler(asyncToken:AsyncToken):void
Parameters
asyncToken:AsyncToken |
name | Constant |
public static const name:String = report/ReturnStdGeography
Task name.