com.esri.bao.tasks.stdgeographies.StdGeographiesByAttributesTask

Package	com.esri.bao.tasks.stdgeographies
Class	public final class StdGeographiesByAttributesTask
Inheritance	StdGeographiesByAttributesTask BAOnlineTask BATask AbstractTask flash.events.EventDispatcher

The StdGeographiesByAttributesTask class requests a list of feature/area names and their corresponding IDs based on the result of a string-based query on a Business Analyst Online data layer.

Some applications of Standard Geographies by Attribute include the following:

Suppose particular named geographic areas or regions have been identified by stakeholders for analysis. Given the partial or complete names of these areas of interest, Standard Geographies by Attributes can be used to look up their corresponding FIPS codes in order to specify the particular areas of interest in other analyses such as Summary Reports.
United States Postal Services (USPS) ZIP code prefixes are a 3-digit code associated with USPS Sectional Center Facilities (SCFs). These SCFs generally represent a particular USPS geographic service area such as a city or a part of a city. Standard Geographies by Attributes can be used to look up the ZIP codes containing a 3-digit string. For example, the ZIP code prefix 065 is associated with the USPS SCF for New Haven, Connecticut. In this particular case, every single ZIP code in New Haven is associated with the SCF. By using Standard Geographies by Attributes and specifying the query string 065 on the Business Analyst Online ZIP code data layer, a complete list of ZIP codes for the city of New Haven will be included in the output response along with all other ZIP codes containing the 065 string. In subsequent analysis, these ZIP code IDs that begin with "065" can be used to specify all New Haven ZIP codes in a Summary Reports analysis task using a StandardLayer.

The result of this task is an array of IDNamePair items containing all of the feature/area names and their corresponding IDs that satisfy the string-based query on the data layer. After looking up these IDs, they may be used to specify one or more geographic features/areas in a Summary Reports analysis using the StandardLayer as the value for the Boundaries parameter.

	Property	Defined by
		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 Standard Geographies by Attributes task.	StdGeographiesByAttributesTask
		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
		StdGeographiesByAttributesTask(urlOrClient:Object = null) Creates a new instance of the StdGeographiesByAttributesTask class.	StdGeographiesByAttributesTask
		createCommand(parameters:StdGeographiesByAttributesParameters, commandName:String = null):BACommand Creates a new command encapsulating this task and the given parameters.	StdGeographiesByAttributesTask
		execute(parameters:StdGeographiesByAttributesParameters, responder:IResponder = null):AsyncToken Sends a request for executing a Standard Geographies by Attributes task to the Business Analyst Online HTTP (REST) Service.	StdGeographiesByAttributesTask

	Event	Summary	Defined by
		fault	The fault event is dispatched when an asynchronous execution of a Business Analyst task fails.	BATask
		taskCompleted	The taskCompleted event is dispatched when an asynchronous execution of a Business Analyst task successfully completes.	BATask

	Constant	Defined by
		name : String = "report/StdGeographiesByAttributes" [static] Task name.	StdGeographiesByAttributesTask

See also

BAOnlineClient

Method detail

createCommand

()

method

public function createCommand(parameters:StdGeographiesByAttributesParameters, commandName:String = null):BACommand

Creates a new command encapsulating this task and the given parameters.

Parameters

	`parameters:StdGeographiesByAttributesParameters` — Parameters of a task to be executed.

	`commandName:String` (default = `null`) — Command name.

Returns

BACommand — A new command.

execute

()

method

public function execute(parameters:StdGeographiesByAttributesParameters, responder:IResponder = null):AsyncToken

Sends a request for executing a Standard Geographies by Attributes task to the Business Analyst Online 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:StdGeographiesByAttributesParameters` — Parameters of the task.

	`responder:IResponder` (default = `null`) — A responder to call on result or fault.

Returns

AsyncToken — Asynch token associated with the response.

Constant detail

name

constant

public static const name:String = "report/StdGeographiesByAttributes"

Task name.

ESRI Business Analyst Online API 1.0 beta for Flex	All Packages \| All Classes \| Index \| Frames No Frames
Class StdGeographiesByAttributesTask	Properties \| Methods \| Events \| Constants