| Package | com.esri.baserver.tasks.rendering |
| Class | public final class GetDefaultMapDescriptionTask |
| Inheritance | GetDefaultMapDescriptionTask  BAServerTask BATask AbstractTask flash.events.EventDispatcher |
The map description is used in parameters of Business Analyst Server tasks which can render an output layer as an image. This object is represented in REST API as a string containing an XML representation of the MapDescription object. This object is now optional in the rendering parameters of tasks. If it is omitted, the analysis results are rendered on the default map.
The result of this task is a string containing an XML representation of the MapDescription object.
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 : String [read-only]
The last result of executing the Get Default Map Description task. | GetDefaultMapDescriptionTask | ||
| 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 | ||
|---|---|---|---|
GetDefaultMapDescriptionTask(urlOrClient:Object = null)
Creates a new instance of the GetDefaultMapDescriptionTask class. | GetDefaultMapDescriptionTask | ||
createCommand(commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters. | GetDefaultMapDescriptionTask | ||
[static]
Creates parameters of this task in order to execute it with a generic or batch task. | GetDefaultMapDescriptionTask | ||
execute(responder:IResponder = null):AsyncToken
Sends a request for executing a Get Default Map Description task to the Business Analyst Server HTTP (REST) Service. | GetDefaultMapDescriptionTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = GetDefaultMapDescription [static] Task name. | GetDefaultMapDescriptionTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:String [read-only] The last result of executing the Get Default Map Description task.
public function get lastResult():String| GetDefaultMapDescriptionTask | () | Constructor |
public function GetDefaultMapDescriptionTask(urlOrClient:Object = null)Creates a new instance of the GetDefaultMapDescriptionTask 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(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 Default Map Description 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 = GetDefaultMapDescriptionTask name.
getDefaultMapDescriptionTask.execute(new Responder(resultHandler, faultHandler));