Package | com.esri.baserver.tasks.rendering |
Class | public final class RemoveLayersFromMapTask |
Inheritance | RemoveLayersFromMapTask BAServerTask BATask AbstractTask flash.events.EventDispatcher |
The result of this task is a Boolean variable whose value is true if at least one layer was removed from the default map.
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 : Boolean [read-only]
The last result of executing the Remove Layers from Map task. | RemoveLayersFromMapTask | ||
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 | ||
---|---|---|---|
RemoveLayersFromMapTask(urlOrClient:Object = null)
Creates a new instance of the RemoveLayersFromMapTask class. | RemoveLayersFromMapTask | ||
createCommand(layerNames:Array, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters. | RemoveLayersFromMapTask | ||
createParameters(layerNames:Array):IBATaskParameters [static]
Creates parameters of this task in order to execute it with a generic or batch task. | RemoveLayersFromMapTask | ||
execute(layerNames:Array, responder:IResponder = null):AsyncToken
Sends a request for executing a Remove Layers from Map task to the Business Analyst Server HTTP (REST) Service. | RemoveLayersFromMapTask |
Constant | Defined By | ||
---|---|---|---|
name : String = RemoveLayersFromMap [static] Task name. | RemoveLayersFromMapTask |
lastResult | property |
lastResult:Boolean
[read-only] The last result of executing the Remove Layers from Map task.
public function get lastResult():Boolean
RemoveLayersFromMapTask | () | Constructor |
public function RemoveLayersFromMapTask(urlOrClient:Object = null)
Creates a new instance of the RemoveLayersFromMapTask 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 ) — A variable containing either Business Analyst Server HTTP Service base URL string or an
instance of the BAServerClient class.
|
See also
createCommand | () | method |
public function createCommand(layerNames:Array, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
Parameters
layerNames:Array — Names of layers to be removed from the default map.
This array should contain items of the String type.
| |
commandName:String (default = null ) — Command name.
|
BACommand — A new command.
|
createParameters | () | method |
public static function createParameters(layerNames:Array):IBATaskParameters
Creates parameters of this task in order to execute it with a generic or batch task.
Parameters
layerNames:Array — Names of layers to be removed from the default map.
This array should contain items of the String type.
|
IBATaskParameters — Parameters of this task.
|
See also
execute | () | method |
public function execute(layerNames:Array, responder:IResponder = null):AsyncToken
Sends a request for executing a Remove Layers from Map 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
layerNames:Array — Names of layers to be removed from the default map.
This array should contain items of the String type.
| |
responder:IResponder (default = null ) — A responder to call on result or fault.
|
AsyncToken — Asynch token associated with the response.
|
See also
name | Constant |
public static const name:String = RemoveLayersFromMap
Task name.
// The layerNames parameter specifies an array of names of layers to be removed from the map. removeLayersFromMapTask.execute(layerNames, new Responder(resultHandler, faultHandler));