Packagecom.esri.bao.tasks
Classpublic class BAOnlineTask
InheritanceBAOnlineTask Inheritance BATask Inheritance AbstractTask Inheritance flash.events.EventDispatcher
Implements IBADatasetParameters
Subclasses BAOnlineBatchTask, BAOnlineGenericTask, BenchmarkReportTask, DriveTimeTask, GeofenceInfoTask, GetDatasetsTask, GetReportTemplatesTask, GetStandardGeographyLevelsTask, GetSummarizationsTask, ReturnStdGeographyTask, SimpleRingsTask, StdGeographiesByAttributesTask, StdGeographiesFromExtentTask, SummaryReportsTask

The BAOnlineTask class is the base class for a Community Analyst task.



Public Properties
 PropertyDefined By
  activeDatasetID : String
Active dataset ID.
BAOnlineTask
 Inheritedconcurrency : String
Value that indicates how to handle multiple calls to the same task.
AbstractTask
 InheriteddisableClientCaching : 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
 InheritedproxyURL : String
The URL to proxy the request through.
AbstractTask
 InheritedrequestTimeout : Number
The request timeout in seconds.
AbstractTask
 InheritedshowBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing.
AbstractTask
 Inheritedtoken : String
Token for accessing a secure task.
AbstractTask
 InheritedtokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires.
BATask
 Inheritedurl : String
URL of the task.
AbstractTask
Public Methods
 MethodDefined By
  
BAOnlineTask(urlOrClient:Object = null)
Creates a new instance of the BAOnlineTask class.
BAOnlineTask
Events
 Event Summary Defined By
 InheritedThe fault event is dispatched when an asynchronous execution of a Community Analyst Task fails.BATask
 InheritedThe taskCompleted event is dispatched when an asynchronous execution of a Community Analyst Task successfully completes.BATask
Property Detail
activeDatasetIDproperty
activeDatasetID:String

Active dataset ID.

An active dataset ID could be applied to tasks whose parameters implement the IBADatasetParameters interface. The value of an active dataset ID specified in this interface has a precedence on the value specified in the task class instance. If both values are missing, the default Community Analyst dataset is used.

The default value is null.


Implementation
    public function get activeDatasetID():String
    public function set activeDatasetID(value:String):void

See also

Constructor Detail
BAOnlineTask()Constructor
public function BAOnlineTask(urlOrClient:Object = null)

Creates a new instance of the BAOnlineTask 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.

Parameters
urlOrClient:Object (default = null) — A variable containing either Community Analyst HTTP Service URL string or an instance of the BAOnlineClient class.

See also