| Package | com.esri.baserver.tasks.utilities |
| Class | public final class GetAvailableReportFormatsTask |
| Inheritance | GetAvailableReportFormatsTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
The following formats are currently used in Business Analyst Server reports:
| Name | Description |
|---|---|
| "PDF" | PDF format. |
| "HTML" | HTML format. |
| "CSV" | Excel comma separated values format. |
| "S.XML" | Simplified XML format. |
| "ZIP" | Zipped HTML format. |
The S.XML format is the simplified version of XML format in which all simple nodes having a unique tag relative to its parent are replaced with corresponding attributes of the parent.
The result of this task is an array of String items containing names of available formats.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAServerTask | |
| 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
Produce an error message with stack trace (true) or without stack trace (false). | BAServerTask | |
| lastResult : Array [read-only]
The last result of executing the Get Available Report Formats task. | GetAvailableReportFormatsTask | ||
| 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 | ||
|---|---|---|---|
GetAvailableReportFormatsTask(urlOrClient:Object = null)
Creates a new instance of the GetAvailableReportFormatsTask class. | GetAvailableReportFormatsTask | ||
[static]
Creates parameters of this task in order to execute it with a generic or batch task. | GetAvailableReportFormatsTask | ||
execute(responder:IResponder = null):AsyncToken
Sends a request for executing a Get Available Report Formats task to the Business Analyst Server HTTP (REST) Service. | GetAvailableReportFormatsTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = GetAvailableReportFormats [static] Task name. | GetAvailableReportFormatsTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:Array [read-only] The last result of executing the Get Available Report Formats task. This array contains items of the String type.
public function get lastResult():Array| GetAvailableReportFormatsTask | () | Constructor |
public function GetAvailableReportFormatsTask(urlOrClient:Object = null)Creates a new instance of the GetAvailableReportFormatsTask 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
| 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 Available Report Formats 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 = GetAvailableReportFormatsTask name.
getAvailableReportFormatsTask.execute(new Responder(resultHandler, faultHandler));