Packagecom.esri.baserver.tasks
Classpublic class BAServerTask
InheritanceBAServerTask Inheritance BATask Inheritance AbstractTask Inheritance flash.events.EventDispatcher
Implements IBADatasetParameters
Subclasses AddFeaturesTask, AddLayersToMapTask, AssignCustomersByClosestStoreTask, AssignCustomersByTradeAreaTask, AverageDriveTimeReportTask, BAServerBatchTask, BAServerGenericTask, BenchmarkReportTask, CopyProjectTask, CoreDevelopSegmentsTask, CreateProjectTask, CreateRecordSetByAddressesTask, CreateStdGeographiesTask, CreateWorkspaceTask, CustomerDemographicComparisonTask, CustomerDemographicProfileTask, CustomerDerivedAreasTask, CustomerGeographicSummaryTask, CustomerProfilingTask, CustomerProspectingTask, CustomerStoreSetupByCoordinatesTask, CustomerStoreSetupByGeocodeTableTask, DeleteFeaturesTask, DeleteItemTask, DeleteProjectTask, DeleteWorkspaceTask, DesireLinesTask, DistanceDecayTask, DriveTimeTask, EditFeaturesTask, FindSimilarTask, GamePlanChartTask, GamePlanMapTask, GetAvailableReportFormatsTask, GetCustomLayersTask, GetDataHierarchiesTask, GetDatasetsTask, GetDefaultMapDescriptionTask, GetListProjectItemsTask, GetMRIGroupsTask, GetProjectsTask, GetReportTask, GetReportTemplatesTask, GetSegmentationBasesTask, GetSegmentationLevelsTask, GetSegmentsTask, GetStandardGeographyLevelsTask, GetSummarizationsTask, GetVersionTask, GetWorkspacesTask, GridsTask, LocatorReportTask, MarketPenetrationTask, MarketRankingTask, MatchLevelSummaryReportTask, MeasureCannibalizationTask, MultiProfileBarChartTask, OpenFeatureLayerTask, OpenSegmentationProfileTask, OpenSegmentationTargetGroupTask, PointsInPolygonReportTask, ProfileByAreaSummationTask, ProfileByImportFromTableTask, ProfileByTableGeocodingTask, ProfileComparisonChartTask, RemoveLayersFromMapTask, RemoveOverlapTask, RenameProjectTask, RenameWorkspaceTask, RenderAnalysesTask, ReportFromProfileTask, ReturnStdGeographyTask, SelectBusinessesTask, SelectLocationsTask, SetProjectPropertiesTask, SimpleRingsTask, SpatialOverlayTask, StandardLevelsOfGeographyTask, StdGeographiesByAttributesTask, StdGeographiesFromExtentTask, StdGeographiesFromTreeTask, StdGeographiesListTask, StdGeographiesTreeTask, SummarizePointsTask, SummaryReportsTask, TapestryProfileReportTask, TargetGroupTask, TargetMapTask, TargetPenetrationMapTask, ThresholdRingsRadiiTask, ThresholdRingsTask, UnderstandingTargetCustomersTask, UploadFeatureSetTask, UploadShapefileTask

The BAServerTask class is the base class for a Business Analyst Server task.


Public Properties
 PropertyDefined By
  activeDatasetID : 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
  isFullErrorMessage : Boolean
Produce an error message with stack trace (true) or without stack trace (false).
BAServerTask
 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
  
BAServerTask(urlOrClient:Object = null)
Creates a new instance of the BAServerTask class.
BAServerTask
Events
 Event Summary Defined By
 Inherited
fault
The fault event is dispatched when an asynchronous execution of a Community Analyst Task fails.BATask
 Inherited
taskCompleted
The taskCompleted event is dispatched when an asynchronous execution of a Community Analyst Task successfully completes.BATask
Property Detail
activeDatasetIDproperty
activeDatasetID:String

Active dataset ID.

An active dataset ID could be applied to tasks whose parameters implement the IBADatasetParameters interface. The value of an active dataset ID specified in this interface has a precedence on the value specified in the task class instance. If both values are missing, the default Business Analyst Server dataset is used. The default dataset is the first dataset in the dataset list returned with the Get Datasets task.

The default value is null.


Implementation
    public function get activeDatasetID():String
    public function set activeDatasetID(value:String):void

See also

IBADatasetParameters
GetDatasetsTask
isFullErrorMessageproperty 
isFullErrorMessage:Boolean

Produce an error message with stack trace (true) or without stack trace (false).


Implementation
    public function get isFullErrorMessage():Boolean
    public function set isFullErrorMessage(value:Boolean):void
Constructor Detail
BAServerTask()Constructor
public function BAServerTask(urlOrClient:Object = null)

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

BAServerClient



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00