Packagecom.esri.baserver.tasks.repository
Classpublic final class AddFeaturesTask
InheritanceAddFeaturesTask Inheritance BAServerTask Inheritance BATask Inheritance AbstractTask Inheritance flash.events.EventDispatcher

The Add Features task adds features from a data layer to an existing feature layer in the repository.

Both source data layer and destination items should have the same (point or polygon) geometry type. The source layer can be a folder item, a feature record set, or an array of point records. Only attribute fields specified in the destination item are copied from source layer features. Other fields are ignored.

The result of this task is true if the features were successfully added.

View the examples



Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAServerTask
 Inheritedconcurrency : String
Value that indicates how to handle multiple calls to the same task.
AbstractTask
 InheriteddisableClientCaching : 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
 InheritedisFullErrorMessage : 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 Add Features task.
AddFeaturesTask
 InheritedproxyURL : String
The URL to proxy the request through.
AbstractTask
 InheritedrequestTimeout : Number
The request timeout in seconds.
AbstractTask
 InheritedshowBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing.
AbstractTask
 Inheritedtoken : String
Token for accessing a secure task.
AbstractTask
 InheritedtokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires.
BATask
 Inheritedurl : String
URL of the task.
AbstractTask
Public Methods
 MethodDefined By
  
AddFeaturesTask(urlOrClient:Object = null)
Creates a new instance of the AddFeaturesTask class.
AddFeaturesTask
  
createCommand(sourceLayer:PointLayer, destinationItem:FolderItem, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
AddFeaturesTask
  
[static] Creates parameters of this task in order to execute it with a generic or batch task.
AddFeaturesTask
  
execute(sourceLayer:PointLayer, destinationItem:FolderItem, responder:IResponder = null):AsyncToken
Sends a request for executing an Add Features task to the Business Analyst Server HTTP (REST) Service.
AddFeaturesTask
Events
 Event Summary Defined By
 InheritedThe fault event is dispatched when an asynchronous execution of a Community Analyst Task fails.BATask
 InheritedThe taskCompleted event is dispatched when an asynchronous execution of a Community Analyst Task successfully completes.BATask
Public Constants
 ConstantDefined By
  name : String = AddFeatures
[static] Task name.
AddFeaturesTask
Property Detail
lastResultproperty
lastResult:Boolean  [read-only]

The last result of executing the Add Features task.


Implementation
    public function get lastResult():Boolean
Constructor Detail
AddFeaturesTask()Constructor
public function AddFeaturesTask(urlOrClient:Object = null)

Creates a new instance of the AddFeaturesTask 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.

Parameters
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

Method Detail
createCommand()method
public function createCommand(sourceLayer:PointLayer, destinationItem:FolderItem, commandName:String = null):BACommand

Creates a new command encapsulating this task and the given parameters.

Parameters

sourceLayer:PointLayer — Source point or polygon data layer.
 
destinationItem:FolderItem — Destination folder item.
 
commandName:String (default = null) — Command name.

Returns
BACommand — A new command.
createParameters()method 
public static function createParameters(sourceLayer:PointLayer, destinationItem:FolderItem):IBATaskParameters

Creates parameters of this task in order to execute it with a generic or batch task.

Parameters

sourceLayer:PointLayer — Source point or polygon data layer.
 
destinationItem:FolderItem — Destination folder item.

Returns
IBATaskParameters — Parameters of this task.

See also

execute()method 
public function execute(sourceLayer:PointLayer, destinationItem:FolderItem, responder:IResponder = null):AsyncToken

Sends a request for executing an Add Features 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

sourceLayer:PointLayer — Source point or polygon data layer.
 
destinationItem:FolderItem — Destination folder item.
 
responder:IResponder (default = null) — A responder to call on result or fault.

Returns
AsyncToken — Asynch token associated with the response.
Constant Detail
nameConstant
public static const name:String = AddFeatures

Task name.

Examples
ActionScript to execute an Add Features task:
     
     // sourceLayer is a point or polygon layer whose features will be added.
     // destinationItem is a destination repository layer having the same geometry type as the source layer.
     
     addFeaturesTask.execute(sourceLayer, destinationItem, new Responder(resultHandler, faultHandler));