Packagecom.esri.bacore.client
Classpublic class SummaryReportParameters
InheritanceSummaryReportParameters Inheritance BATaskParameters Inheritance Object
Subclasses DriveTimeParameters, SimpleRingsParameters, SummaryReportsParameters, SummaryReportsParameters, TradeAreaTaskParameters

The SummaryReportParameters class is the base class for tasks producing summary reports.


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
  reportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type.
SummaryReportParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
Public Methods
 MethodDefined By
  
SummaryReportParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the SummaryReportParameters class.
SummaryReportParameters
  
toURLVariables():URLVariables
[override] Converts task parameters to URL variables.
SummaryReportParameters
Protected Methods
 MethodDefined By
  
setDefaultOutputTypes(outputTypes:OutputTypes):void
[override] Sets default output types.
SummaryReportParameters
Property Detail
reportOptionsproperty
reportOptions:Array

Array of summary reports options constisting of items of the ReportOptions type.


Implementation
    public function get reportOptions():Array
    public function set reportOptions(value:Array):void
Constructor Detail
SummaryReportParameters()Constructor
public function SummaryReportParameters(taskName:String, outputTypes:OutputTypes = null)

Creates a new instance of the SummaryReportParameters class.

Parameters
taskName:String — Name of a Community Analyst Task associated with these parameters.
 
outputTypes:OutputTypes (default = null) — Task output types.
Method Detail
setDefaultOutputTypes()method
override protected function setDefaultOutputTypes(outputTypes:OutputTypes):void

Sets default output types. This method sets the getReport value to true if reports options are specified.

Parameters

outputTypes:OutputTypes

toURLVariables()method 
override public function toURLVariables():URLVariables

Converts task parameters to URL variables. Method of this class verifies that the reports options are specified if a report output is requested. It also adds the ReportOptions variable to URL variables if a report output is requested.

Returns
URLVariables — URL variables.

Throws
BARequestError — Report output is requested, but reports options are missing.



© 2011 Esri, Inc. All rights reserved.

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