| Package | com.esri.bao.tasks.utilities |
| Class | public final class GetSummarizationsTask |
| Inheritance | GetSummarizationsTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
The result of this task is an array of SummarizationInfo objects providing metainformation
about summariation fields. The summarization field names may be used
in parameters of reports such as the Benchmark Report.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAOnlineTask | |
| 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 | |
| lastResult : Array [read-only]
The last result of executing the GetSummarizations task. | GetSummarizationsTask | ||
| 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 | ||
|---|---|---|---|
GetSummarizationsTask(urlOrClient:Object = null)
Creates a new instance of the GetSummarizationsTask class. | GetSummarizationsTask | ||
createCommand(parametersOrCommandName:Object = null, commandName:String = null):BACommand
Creates a new command encapsulating this task and the given parameters. | GetSummarizationsTask | ||
Deprecated Since Community Analyst API for Flex 2.2: Please Use com.esri.bao.tasks.utilities.GetSummarizationsParameters [static]
Creates parameters of this task (this method is deprecated). | GetSummarizationsTask | ||
execute(parametersOrResponder:Object = null, responder:IResponder = null):AsyncToken
Sends a request for executing a GetSummarizations task to the Community Analyst HTTP (REST) Service. | GetSummarizationsTask | ||
| Method | Defined By | ||
|---|---|---|---|
resultHandler(asyncToken:AsyncToken):void [override] | GetSummarizationsTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/GetSummarizations [static] Task name. | GetSummarizationsTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:Array [read-only] The last result of executing the GetSummarizations task. Type array of SummarizationInfo items.
public function get lastResult():ArraySee also
| GetSummarizationsTask | () | Constructor |
public function GetSummarizationsTask(urlOrClient:Object = null)Creates a new instance of the GetSummarizationsTask 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 Community Analyst Web Services looks as follows:
http://{host}:{port}
The {host} and {port} parameters in this URL should be substituted with
valid Community Analyst host name and port, respectively.
If urlOrClient is null, the "http://baoapi.esri.com" value is assigned as the base URL.
urlOrClient:Object (default = null) |
See also
| createCommand | () | method |
public function createCommand(parametersOrCommandName:Object = null, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
NOTE: The first parameter of this method is either an instance of the GetSummarizationsParameters class or a command name as String value. The string is allowed here if the last parameter is null. The case when this method receives a single string parameter is deprecated.
Parameters
parametersOrCommandName:Object (default = null) | |
commandName:String (default = null) |
BACommand — A new command.
|
See also
| createParameters | () | method |
public static function createParameters():IBATaskParametersCreates parameters of this task (this method is deprecated).
ReturnsIBATaskParameters — Task parameters.
|
See also
| execute | () | method |
public function execute(parametersOrResponder:Object = null, responder:IResponder = null):AsyncTokenSends a request for executing a GetSummarizations task to the Community Analyst 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 for listeners of this task.
If a response is succesfully received and parsed, the result is assigned to the
lastResult property of this task.
NOTE: The first parameter of this method is either an instance of the GetSummarizationsParameters class or IResponder interface. The responder is allowed here if the last parameter is null. The case when this method receives a single responder parameter is deprecated.
Parameters
parametersOrResponder:Object (default = null) | |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
See also
| resultHandler | () | method |
override protected function resultHandler(asyncToken:AsyncToken):voidParameters
asyncToken:AsyncToken |
| name | Constant |
public static const name:String = report/GetSummarizationsTask name.