Packagecom.esri.baserver.tasks.reports
Classpublic class CustomerGeographicSummaryParameters
InheritanceCustomerGeographicSummaryParameters Inheritance StandardReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The CustomerGeographicSummaryParameters class provides input parameters for the Customer Geographic Summary task.

Output options for this task include creating a report (outputTypes.getReport). You need not specify the output options for this task because the getReport output type is set by default.

View the examples

See also

CustomerGeographicSummaryTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  customers : PointLayer
The customer layer used to get the geographic summary for (required).
CustomerGeographicSummaryParameters
 InheritedoutputReportItem : FolderItem
Configuration options for storing the output report in the repository.
StandardReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
 InheritedresultType : BAResultType
[read-only] Type of the result returned by the task associated with these parameters.
BATaskParameters
 InheritedstandardReportOptions : ReportOptions
Standard report options.
StandardReportParameters
 InheritedtaskName : String
[read-only] Name of a Community Analyst Task associated with these parameters.
BATaskParameters
Public Methods
 MethodDefined By
  
Creates a new instance of the CustomerGeographicSummaryParameters class.
CustomerGeographicSummaryParameters
Property Detail
customersproperty
customers:PointLayer

The customer layer used to get the geographic summary for (required).


Implementation
    public function get customers():PointLayer
    public function set customers(value:PointLayer):void
Constructor Detail
CustomerGeographicSummaryParameters()Constructor
public function CustomerGeographicSummaryParameters(customers:PointLayer = null)

Creates a new instance of the CustomerGeographicSummaryParameters class.

Parameters
customers:PointLayer (default = null) — The customer layer used to get the geographic summary for.
Examples
ActionScript to create CustomerGeographicSummaryParameters and then use in a Customer Geographic Summary task:
                     
     var parameters : CustomerGeographicSummaryParameters = new CustomerGeographicSummaryParameters();
     
     // The PointLayer type could take either data as type
     // com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
     // or an array of com.esri.bacore.PointRecord items, e.g.
     //var points:Array = [new PointRecord("Customer 1", "Steiner St. & Geary Blvd", "1", 37.78415, -122.4346)];
     
     // Set customers as an array of PointRecord items.
     parameters.customers = new PointLayer(points);
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
      
     customerGeographicSummaryTask.execute(parameters, new Responder(resultHandler, faultHandler));