| 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 | ||
|---|---|---|---|
 | 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
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 | ||
|---|---|---|---|
|
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 Business Analyst Online batch task to the Business Analyst Online HTTP (REST) Service.
| BAOnlineBatchTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:BatchTaskParameters [read-only]The last result of execution the batch task.
Implementation public function get lastResult():BatchTaskParameters
| 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 Business Analyst Online Web Services looks as follows:
http://{host}:{port}
The {host} and {port} parameters in this URL should be substituted with
a valid Business Analyst Online 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.
Parametersparameters: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 Business Analyst Online batch task to the Business Analyst Online 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:BatchTaskParameters — Parameters of a task to be executed.
|
|
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|