Packagecom.esri.bacore.client
Classpublic class StandardReportParameters
InheritanceStandardReportParameters Inheritance BATaskParameters Inheritance Object
Subclasses AnalysisAndReportParameters, BenchmarkReportParameters, StandardReportParameters

The StandardReportParameters class is the base class for tasks producing standard reports.


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

Standard report options.


Implementation
    public function get standardReportOptions():ReportOptions
    public function set standardReportOptions(value:ReportOptions):void
Constructor Detail
StandardReportParameters()Constructor
public function StandardReportParameters(taskName:String, outputTypes:OutputTypes = null)

Creates a new instance of the StandardReportParameters 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 standard report options are specified.

Parameters

outputTypes:OutputTypes — Output types to specify default values in.

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

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

Returns
URLVariables — URL variables.

Throws
BARequestError — The report output is requested but report options are missing..



© 2011 Esri, Inc. All rights reserved.

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