| Package | com.esri.baserver.tasks.reports |
| Class | public final class LocatorReportTask |
| Inheritance | LocatorReportTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
This task generates a report that will determine the proximity of locations to a given set of center points. For example, you can use this method to illustrate the proximity of competitors to each store location. This report will list and display all the competitor locations that are closest to each store and allows you to examine their geographic patterns and distribution.
The result of this task is a TaskResultOutput object,
which is compatible with ArcGIS Server's mapping APIs. FeatureSet, MapImage, and an array of
ReportInfo objects can be returned in it depending on task output options requested.
The array of ReportInfo items if returned contains the single report.
Additionally, the output analysis layer and/or report can be stored to the Business Analyst Server repository.
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 : TaskResultOutput [read-only]
The last result of executing the Locator Report task. | LocatorReportTask | ||
| 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 | ||
|---|---|---|---|
LocatorReportTask(urlOrClient:Object = null)
Creates a new instance of the LocatorReportTask class. | LocatorReportTask | ||
Creates a new command encapsulating this task and the given parameters. | LocatorReportTask | ||
execute(parameters:LocatorReportParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Locator Report task to the Business Analyst Server HTTP (REST) Service. | LocatorReportTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = LocatorReport [static] Task name. | LocatorReportTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:TaskResultOutput [read-only] The last result of executing the Locator Report task.
public function get lastResult():TaskResultOutput| LocatorReportTask | () | Constructor |
public function LocatorReportTask(urlOrClient:Object = null)Creates a new instance of the LocatorReportTask 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:LocatorReportParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:LocatorReportParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:LocatorReportParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Locator Report 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:LocatorReportParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = LocatorReportTask name.