| Package | com.esri.bao.tasks.reports |
| Class | public final class SummaryReportsTask |
| Inheritance | SummaryReportsTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
With several report template options, Summary Reports leverages Community Analyst's data layers to comprehensively describe, analyze, and summarize information associated with the input boundary areas. Summary Reports may also be leveraged to create mappable Feature Class representations of named geographic locations and boundary areas.
The result of this task is a TaskResultOutput object,
which is compatible with ArcGIS Server's mapping APIs.
This task creates one or more reports for a given boundary layer.
It should be primarily used to create reports for Community Analyst trade areas.
Optional analysis, which can be requested simultaneously, includes the creation a feature record set
and a map image for given boundary layer.
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 : TaskResultOutput [read-only]
The last result of executing the Summary Reports task. | SummaryReportsTask | ||
| 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 | ||
|---|---|---|---|
SummaryReportsTask(urlOrClient:Object = null)
Creates a new instance of the SummaryReportsTask class. | SummaryReportsTask | ||
Creates a new command encapsulating this task and the given parameters. | SummaryReportsTask | ||
execute(parameters:SummaryReportsParameters, responder:IResponder = null):AsyncToken
Sends a request for execution a Summary Reports task to the Community Analyst HTTP (REST) Service. | SummaryReportsTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/SummaryReports [static] Task name. | SummaryReportsTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the Summary Reports task.
public function get lastResult():TaskResultOutput| SummaryReportsTask | () | Constructor |
public function SummaryReportsTask(urlOrClient:Object = null)Creates a new instance of the SummaryReportsTask 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 Web Services 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) |
See also
| createCommand | () | method |
public function createCommand(parameters:SummaryReportsParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:SummaryReportsParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:SummaryReportsParameters, responder:IResponder = null):AsyncTokenSends a request for execution a Summary Reports 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:SummaryReportsParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = report/SummaryReportsTask name.