| Package | com.esri.bao.tasks.utilities |
| Class | public final class GetDatasetsTask |
| Inheritance | GetDatasetsTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
The result of this task is an array of String items containing IDs of all available datasets.
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAOnlineTask | |
| 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 : Array [read-only]
The last result of executing the Get Datasets task. | GetDatasetsTask | ||
| 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 | ||
|---|---|---|---|
GetDatasetsTask(urlOrClient:Object = null)
Creates a new instance of the GetDatasetsTask class. | GetDatasetsTask | ||
createCommand(commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters. | GetDatasetsTask | ||
[static]
Creates parameters of this task in order to execute it with a generic or batch task. | GetDatasetsTask | ||
execute(responder:IResponder = null):AsyncToken
Sends a request for executing a Get Datasets task to the Business Analyst Server HTTP (REST) Service. | GetDatasetsTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/GetDatasets [static] Task name. | GetDatasetsTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:Array [read-only] The last result of executing the Get Datasets task. This array contains items of the String type.
public function get lastResult():Array| GetDatasetsTask | () | Constructor |
public function GetDatasetsTask(urlOrClient:Object = null)Creates a new instance of the GetDatasetsTask 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.
urlOrClient:Object (default = null) |
See also
| createCommand | () | method |
public function createCommand(commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
commandName:String (default = null) |
BACommand — A new command.
|
| createParameters | () | method |
public static function createParameters():IBATaskParametersCreates parameters of this task in order to execute it with a generic or batch task.
ReturnsIBATaskParameters — Parameters of this task.
|
See also
| execute | () | method |
public function execute(responder:IResponder = null):AsyncTokenSends a request for executing a Get Datasets 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
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = report/GetDatasetsTask name.
getDatasetsTask.execute(new Responder(resultHandler, faultHandler));