| Package | com.esri.bao.tasks |
| Class | public final class BAOnlineBatchTask |
| Inheritance | BAOnlineBatchTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
Tasks to be executed in the batch task are specified with the taskProviders
array in parameters of the batch task. An item of this array is either an object implementing the
IBATaskParameters interface, an instance of the BACommand class or
a function with the following signature:
taskProvider(parameters:BatchTaskParameters, client:BAOnlineClient):Object;
The result of this function should be either an object implementing the
IBATaskParameters interface, an instance of the BACommand class or
null.
See also
| Property | Defined By | ||
|---|---|---|---|
| activeDatasetID : String [override]
Active dataset ID. | BAOnlineBatchTask | ||
 | 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 : BatchTaskParameters [read-only]
The last result of execution the batch task. | BAOnlineBatchTask | ||
| proxyURL : String
The URL to proxy the request through. | AbstractTask | |
| requestTimeout : Number [override]
The request timeout in seconds to be set for every subtask of the batch task. | BAOnlineBatchTask | ||
| 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 | ||
|---|---|---|---|
BAOnlineBatchTask(urlOrClient:Object = null)
Creates a new instance of the BAOnlineBatchTask object. | BAOnlineBatchTask | ||
Creates a new command encapsulating this task and the given parameters. | BAOnlineBatchTask | ||
execute(parameters:BatchTaskParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Community Analyst batch task to the Community Analyst HTTP (REST) Service. | BAOnlineBatchTask | ||
| activeDatasetID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesactiveDatasetID:String[override] 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.
public function get activeDatasetID():String public function set activeDatasetID(value:String):voidSee also
| lastResult | property |
lastResult:BatchTaskParameters [read-only] The last result of execution the batch task.
public function get lastResult():BatchTaskParameters| requestTimeout | property |
requestTimeout:Number[override] The request timeout in seconds to be set for every subtask of the batch task. A value less than or equal to zero prevents request timeout.
The default value is client.requestTimeout.
public function get requestTimeout():Number public function set requestTimeout(value:Number):void| BAOnlineBatchTask | () | Constructor |
public function BAOnlineBatchTask(urlOrClient:Object = null)Creates a new instance of the BAOnlineBatchTask object.
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
a 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:BatchTaskParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:BatchTaskParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:BatchTaskParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Community Analyst batch 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:BatchTaskParameters — Parameters of a task to be executed.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|