com.esri.bao.tasks.BAOnlineTask

Package	com.esri.bao.tasks
Class	public class BAOnlineTask
Inheritance	BAOnlineTask BATask AbstractTask flash.events.EventDispatcher
Subclasses	BAOnlineBatchTask, BAOnlineGenericTask, BenchmarkReportTask, DriveTimeTask, GeofenceInfoTask, GetReportTemplatesTask, GetStandardGeographyLevelsTask, GetSummarizationsTask, ReturnStdGeographyTask, SimpleRingsTask, StdGeographiesByAttributesTask, StdGeographiesFromExtentTask, SummaryReportsTask

The BAOnlineTask class is the base class for a Business Analyst Online task.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		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
		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

Public Methods

	Method		Defined by
		BAOnlineTask(urlOrClient:Object = null) Creates a new instance of the BAOnlineTask class.	BAOnlineTask

Events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined by
		fault	The fault event is dispatched when an asynchronous execution of a Business Analyst task fails.	BATask
		taskCompleted	The taskCompleted event is dispatched when an asynchronous execution of a Business Analyst task successfully completes.	BATask

Constructor detail

BAOnlineTask

()

constructor

public function BAOnlineTask(urlOrClient:Object = null)

Creates a new instance of the BAOnlineTask class.

A new task can be constructed in two ways: as a task sharing a BAOnlineClient type instance with other tasks (the urlOrClient parameter has the BAOnlineClient type) or as a standalone task encapsulating its own client.

The base URL to the Business Analyst Online Web Services looks as follows:

http://{host}:{port}

The {host} and {port} parameters in this URL should be substituted with valid Business Analyst Online host name and port, respectively.

If urlOrClient is null, the "http://baoapi.esri.com" value is assigned as the base URL.

Parameters

urlOrClient:Object (default = null) — A variable containing either Business Analyst Online HTTP Service URL string or an instance of the BAOnlineClient class.

ESRI Business Analyst Online API 1.0 beta for Flex	All Packages \| All Classes \| Index \| Frames No Frames
Class BAOnlineTask	Properties \| Methods \| Events