| Package | com.esri.bacore.adapters |
| Class | public class BaseGetSummarizationsTaskAdapter |
| Inheritance | BaseGetSummarizationsTaskAdapter  ConfigurableTaskAdapter Object |
| Implements | IGetSummarizationsTaskAdapter |
| Subclasses | GetSummarizationsTaskAdapter, GetSummarizationsTaskAdapter, GetXmlSummarizationsTaskAdapter |
| Since : | Business Analyst API for Flex 2.2. |
| Property | Defined By | ||
|---|---|---|---|
| additionalPropertiesParser : Function
A function responsible for parsing additional properties of a summarization variable. | BaseGetSummarizationsTaskAdapter | ||
| groupFilter : ISummarizationFilter
Variables group filter. | BaseGetSummarizationsTaskAdapter | ||
| query : String
Query string applied to Get Summarizations task. | BaseGetSummarizationsTaskAdapter | ||
| summarizationFilter : Function
A filter to be applied to returned summarizations. | BaseGetSummarizationsTaskAdapter | ||
| vintageFilter : ISummarizationFilter
Variables vintage filter. | BaseGetSummarizationsTaskAdapter | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the BaseGetSummarizationsTaskAdapter class. | BaseGetSummarizationsTaskAdapter | ||
 |
Configures this adapter with the client and additional settings. | ConfigurableTaskAdapter | |
execute(responder:IResponder):void
Executes a get summarizations task. | BaseGetSummarizationsTaskAdapter | ||
| additionalPropertiesParser | property |
Hide Inherited Public Methods
Show Inherited Public Methodspublic var additionalPropertiesParser:Function| Since : | Business Analyst API for Flex 3.0. |
A function responsible for parsing additional properties of a summarization variable. The signature of this function should be the following:
additionalPropertiesParser(jsonObject:Object, variable:SummarizationInfo):void;
jsonObject and set
properties of variable object.
| groupFilter | property |
groupFilter:ISummarizationFilterVariables group filter.
The default value is GroupFilter class instance.
public function get groupFilter():ISummarizationFilter public function set groupFilter(value:ISummarizationFilter):void| query | property |
query:StringQuery string applied to Get Summarizations task.
The default value is null.
public function get query():String public function set query(value:String):void| summarizationFilter | property |
public var summarizationFilter:FunctionA filter to be applied to returned summarizations.
This function should have the following signature:
summarizationFilter(summarization:SummarizationInfo):Boolean;
It should return true if the input summarization
matches the filter criteria and false otherwise.
| vintageFilter | property |
vintageFilter:ISummarizationFilterVariables vintage filter.
The default value is VintageFilter class instance.
public function get vintageFilter():ISummarizationFilter public function set vintageFilter(value:ISummarizationFilter):void| BaseGetSummarizationsTaskAdapter | () | Constructor |
public function BaseGetSummarizationsTaskAdapter()Creates a new instance of the BaseGetSummarizationsTaskAdapter class.
| execute | () | method |
public function execute(responder:IResponder):voidExecutes a get summarizations task.
Parameters
responder:IResponder — A responder to handle results.
|