| Package | com.esri.baserver.tasks.tradeareas |
| Class | public class TradeAreaTaskParameters |
| Inheritance | TradeAreaTaskParameters  SummaryReportParameters BATaskParameters Object |
| Subclasses | CustomerDerivedAreasParameters, DriveTimeParameters, GridsParameters, RemoveOverlapParameters, SimpleRingsParameters, StandardLevelsOfGeographyParameters, ThresholdRingsParameters |
Output options for tasks whose parameters inherit from this class
include rendering an output image (outputTypes.getMapImage), creating
a feature class for subsequent analysis (outputTypes.getFeatureClass), and/or
creating a report (outputTypes.getReport).
If no output options are specified, the required output options are specified as follows.
If the renderingParameters parameter is specified, the image output is requested.
If the reportOptions parameter is specified, the report is requested.
If the outputAnalysisItem parameter is specified, the output analysis feature class
will be stored in the repository. If renderingParameters,
reportOptions, and outputAnalysisItem parameters are missing,
the feature class output is requested.
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | TradeAreaTaskParameters | ||
| outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | TradeAreaTaskParameters | ||
| outputReportItems : Array
Array of FolderItem items specifying configuration options for storing
output reports in the repository. | TradeAreaTaskParameters | ||
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | TradeAreaTaskParameters | ||
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | TradeAreaTaskParameters | ||
| 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 | |
| returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | TradeAreaTaskParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
TradeAreaTaskParameters(taskName:String, outputTypes:OutputTypes = null)
Creates a new instance of the TradeAreaTaskParameters class. | TradeAreaTaskParameters | ||
| dataHierarchy | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdataHierarchy:StringName of a data hierarchy used for generating summary reports. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get dataHierarchy():String public function set dataHierarchy(value:String):voidSee also
| outputAnalysisItem | property |
outputAnalysisItem:FolderItemConfiguration options for storing the output feature class in the repository.
public function get outputAnalysisItem():FolderItem public function set outputAnalysisItem(value:FolderItem):void| outputReportItems | property |
outputReportItems:ArrayArray of FolderItem items specifying configuration options for storing output reports in the repository.
public function get outputReportItems():Array public function set outputReportItems(value:Array):void| outputSpatialReference | property |
outputSpatialReference:SpatialReferenceThe spatial reference to return the output feature set in.
public function get outputSpatialReference():SpatialReference public function set outputSpatialReference(value:SpatialReference):void| renderingParameters | property |
renderingParameters:RenderingParametersConfiguration options for rendering output to map image.
public function get renderingParameters():RenderingParameters public function set renderingParameters(value:RenderingParameters):void| returnGeometry | property |
returnGeometry:BooleanAn option specifying the presence of the shape attribute in the returned record set.
The default value is true.
public function get returnGeometry():Boolean public function set returnGeometry(value:Boolean):void| TradeAreaTaskParameters | () | Constructor |
public function TradeAreaTaskParameters(taskName:String, outputTypes:OutputTypes = null)Creates a new instance of the TradeAreaTaskParameters class.
ParameterstaskName:String — Name of a Business Analyst Server task associated with this instance.
| |
outputTypes:OutputTypes (default = null) |