| Package | com.esri.baserver.tasks |
| Class | public final class BAServerBatchTask |
| Inheritance | BAServerBatchTask  BAServerTask 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:BAServerClient):Object;
The result of this function should be either an object implementing the
IBATaskParameters interface, an instance of the BACommand class, another
task provider function, or null.
See also
| Property | Defined By | ||
|---|---|---|---|
| activeDatasetID : String [override]
Active dataset ID. | BAServerBatchTask | ||
 | 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 [override]
Produce an error message with stack trace (true) or without stack trace (false). | BAServerBatchTask | ||
| lastResult : BatchTaskParameters [read-only]
The last result of executing the batch task. | BAServerBatchTask | ||
| 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. | BAServerBatchTask | ||
| 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 | ||
|---|---|---|---|
BAServerBatchTask(urlOrClient:Object = null)
Creates a new instance of the BAServerBatchTask class. | BAServerBatchTask | ||
Creates a new command encapsulating this task and the given parameters. | BAServerBatchTask | ||
execute(parameters:BatchTaskParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Business Analyst Server batch task to the Business Analyst Server HTTP (REST) Service. | BAServerBatchTask | ||
| 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 Business Analyst Server dataset
is used. The default dataset is the first dataset in the dataset list returned with
the Get Datasets task.
The default value is null.
public function get activeDatasetID():String public function set activeDatasetID(value:String):voidSee also
| isFullErrorMessage | property |
isFullErrorMessage:Boolean[override] Produce an error message with stack trace (true) or without stack trace (false).
The default value is false.
public function get isFullErrorMessage():Boolean public function set isFullErrorMessage(value:Boolean):void| lastResult | property |
lastResult:BatchTaskParameters [read-only] The last result of executing 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| BAServerBatchTask | () | Constructor |
public function BAServerBatchTask(urlOrClient:Object = null)Creates a new instance of the BAServerBatchTask 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: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 Business Analyst Server batch 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:BatchTaskParameters — Parameters of a task to be executed.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|