Package | com.esri.bacore.client |
Class | public class SummaryReportParameters |
Inheritance | SummaryReportParameters BATaskParameters Object |
Subclasses | DriveTimeParameters, SimpleRingsParameters, SummaryReportsParameters, SummaryReportsParameters, TradeAreaTaskParameters |
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
reportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type. | SummaryReportParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined 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 |
Method | Defined By | ||
---|---|---|---|
setDefaultOutputTypes(outputTypes:OutputTypes):void [override]
Sets default output types. | SummaryReportParameters |
reportOptions | property |
reportOptions:Array
Array of summary reports options constisting of items of the ReportOptions type.
public function get reportOptions():Array
public function set reportOptions(value:Array):void
SummaryReportParameters | () | Constructor |
public function SummaryReportParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the SummaryReportParameters class.
ParameterstaskName:String — Name of a Community Analyst Task associated with these parameters.
| |
outputTypes:OutputTypes (default = null ) — Task output types.
|
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.
ReturnsURLVariables — URL variables.
|
BARequestError — Report output is requested, but reports options are missing.
|