Packagecom.esri.bacore.adapters
Classpublic class BaseGetSummarizationsTaskAdapter
InheritanceBaseGetSummarizationsTaskAdapter Inheritance ConfigurableTaskAdapter Inheritance Object
Implements IGetSummarizationsTaskAdapter
Subclasses GetSummarizationsTaskAdapter, GetSummarizationsTaskAdapter, GetXmlSummarizationsTaskAdapter

Since : Community Analyst API for Flex 2.2.

The BaseGetSummarizationsTaskAdapter class provides the base abstract implementation of IGetSummarizationsTaskAdapter interface.


Public Properties
 PropertyDefined By
  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
Public Methods
 MethodDefined By
  
BaseGetSummarizationsTaskAdapter()
Creates a new instance of the BaseGetSummarizationsTaskAdapter class.
BaseGetSummarizationsTaskAdapter
 Inherited
configure(client:AbstractClient, settings:TaskAdapterConfiguration = null):void
Configures this adapter with the client and additional settings.
ConfigurableTaskAdapter
  
execute(responder:IResponder):void
Executes a get summarizations task.
BaseGetSummarizationsTaskAdapter
Protected Methods
 MethodDefined By
 Inherited
configureInternalTask(client:AbstractClient):Object
Configures the internal task with the given client class.
ConfigurableTaskAdapter
Property Detail
groupFilterproperty
groupFilter:ISummarizationFilter

Variables group filter.

The default value is GroupFilter class instance.


Implementation
    public function get groupFilter():ISummarizationFilter
    public function set groupFilter(value:ISummarizationFilter):void
queryproperty 
query:String

Query string applied to Get Summarizations task.

The default value is null.


Implementation
    public function get query():String
    public function set query(value:String):void
summarizationFilterproperty 
public var summarizationFilter:Function

A 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.

vintageFilterproperty 
vintageFilter:ISummarizationFilter

Variables vintage filter.

The default value is VintageFilter class instance.


Implementation
    public function get vintageFilter():ISummarizationFilter
    public function set vintageFilter(value:ISummarizationFilter):void
Constructor Detail
BaseGetSummarizationsTaskAdapter()Constructor
public function BaseGetSummarizationsTaskAdapter()

Creates a new instance of the BaseGetSummarizationsTaskAdapter class.

Method Detail
execute()method
public function execute(responder:IResponder):void

Executes a get summarizations task.

Parameters

responder:IResponder — A responder to handle results.




© 2011 Esri, Inc. All rights reserved.

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