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

The Upload Feature Set task uploads a custom feature set into the repository.

The result of this task is true if the custom feature set was successfully uploaded.

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 Upload Feature Set task.
UploadFeatureSetTask
 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
  
UploadFeatureSetTask(urlOrClient:Object = null)
Creates a new instance of the UploadFeatureSetTask class.
UploadFeatureSetTask
  
createCommand(featureSet:FeatureSet, outputAnalysisItem:FolderItem, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters.
UploadFeatureSetTask
  
createParameters(featureSet:FeatureSet, outputAnalysisItem:FolderItem):IBATaskParameters
[static] Creates parameters of this task in order to execute it with a generic or batch task.
UploadFeatureSetTask
  
execute(featureSet:FeatureSet, outputAnalysisItem:FolderItem, responder:IResponder = null):AsyncToken
Sends a request for executing a Upload Feature Set task to the Business Analyst Server HTTP (REST) Service.
UploadFeatureSetTask
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 = UploadFeatureSet
[static] Task name.
UploadFeatureSetTask
Property Detail
lastResultproperty
lastResult:Boolean  [read-only]

The last result of executing the Upload Feature Set task.


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

Creates a new instance of the UploadFeatureSetTask 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(featureSet:FeatureSet, outputAnalysisItem:FolderItem, commandName:String = null):BACommand

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

Parameters

featureSet:FeatureSet — Custom feature set having a point or polygon geometry.
 
outputAnalysisItem:FolderItem — Output folder item.
 
commandName:String (default = null) — Command name.

Returns
BACommand — A new command.
createParameters()method 
public static function createParameters(featureSet:FeatureSet, outputAnalysisItem:FolderItem):IBATaskParameters

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

Parameters

featureSet:FeatureSet — Custom feature set having a point or polygon geometry.
 
outputAnalysisItem:FolderItem — Output folder item.

Returns
IBATaskParameters — Parameters of this task.

See also

execute()method 
public function execute(featureSet:FeatureSet, outputAnalysisItem:FolderItem, responder:IResponder = null):AsyncToken

Sends a request for executing a Upload Feature Set 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

featureSet:FeatureSet — Custom feature set having a point or polygon geometry.
 
outputAnalysisItem:FolderItem — Output 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 = UploadFeatureSet

Task name.

Examples
ActionScript to execute an Upload Custom Trade Area task:
     
     // featureSet is a com.esri.ags.FeatureSet.
     // outputItem is an output repository item.
     
     uploadFeatureSet.execute(featureSet, outputItem, new Responder(resultHandler, faultHandler));