Package | com.esri.baserver.tasks.reports |
Class | public final class AverageDriveTimeReportTask |
Inheritance | AverageDriveTimeReportTask BAServerTask BATask AbstractTask flash.events.EventDispatcher |
This task allows you to analyze existing stores with associated customers and determine the average drive time of all your customers in that market. This is commonly done utilizing the Customer Derived Areas task to define the extent of the market around your stores based on the number and distribution of your customers or based on some volumetric factor such as sales.
For example, if you ran a customer derived trade area of 40/60/80% of your customers, you would be provided with a report that details the average drive time or drive distance for each of these 3 trade areas. This would allow you to determine how to best prospect a new location based on which of these trade areas best defined your core customers. You could simply take this average value(s) to seek new markets by generating drive times around potential new store sites and evaluating the demographics in that area to see if they match the demographics of a successful store.
The result of this task is a TaskResultOutput
object,
which is compatible with ArcGIS Server's mapping APIs. The output report is specified
as a single item of the array of ReportInfo objects.
Additionally, the output 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 Average Drive Time Report task. | AverageDriveTimeReportTask | ||
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 | ||
---|---|---|---|
AverageDriveTimeReportTask(urlOrClient:Object = null)
Creates a new instance of the AverageDriveTimeReportTask class. | AverageDriveTimeReportTask | ||
Creates a new command encapsulating this task and the given parameters. | AverageDriveTimeReportTask | ||
execute(parameters:AverageDriveTimeReportParameters, responder:IResponder = null):AsyncToken
Sends a request for executing an Average Drive Time Report task to the Business Analyst Server HTTP (REST) Service. | AverageDriveTimeReportTask |
Constant | Defined By | ||
---|---|---|---|
name : String = AverageDriveTimeReport [static] Task name. | AverageDriveTimeReportTask |
lastResult | property |
lastResult:TaskResultOutput
[read-only] The last result of executing the Average Drive Time Report task.
public function get lastResult():TaskResultOutput
AverageDriveTimeReportTask | () | Constructor |
public function AverageDriveTimeReportTask(urlOrClient:Object = null)
Creates a new instance of the AverageDriveTimeReportTask 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 ) — A variable containing either Business Analyst Server HTTP Service base URL string or an
instance of the BAServerClient class.
|
See also
createCommand | () | method |
public function createCommand(parameters:AverageDriveTimeReportParameters, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
Parameters
parameters:AverageDriveTimeReportParameters — Parameters of a task to be executed.
| |
commandName:String (default = null ) — Command name.
|
BACommand — A new command.
|
execute | () | method |
public function execute(parameters:AverageDriveTimeReportParameters, responder:IResponder = null):AsyncToken
Sends a request for executing an Average Drive Time 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:AverageDriveTimeReportParameters — Parameters of the task.
| |
responder:IResponder (default = null ) — A responder to call on result or fault.
|
AsyncToken — Asynch token associated with the response.
|
name | Constant |
public static const name:String = AverageDriveTimeReport
Task name.