Packagecom.esri.baserver.tasks.reports
Classpublic class MatchLevelSummaryReportParameters
InheritanceMatchLevelSummaryReportParameters Inheritance StandardReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The MatchLevelSummaryReportParameters class provides input parameters for the Match Level Summary Report 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

MatchLevelSummaryReportTask
CustomerStoreSetupByGeocodeTableTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  customerDescription : String
Description or alias for the term "customers".
MatchLevelSummaryReportParameters
  customerLayer : PointLayer
The customer layer to calculate match level summary on.
MatchLevelSummaryReportParameters
 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 MatchLevelSummaryReportParameters class.
MatchLevelSummaryReportParameters
Property Detail
customerDescriptionproperty
customerDescription:String

Description or alias for the term "customers". For example, this could be "patients", "subscribers", "customers", and so forth.

The default value is "customers".


Implementation
    public function get customerDescription():String
    public function set customerDescription(value:String):void
customerLayerproperty 
customerLayer:PointLayer

The customer layer to calculate match level summary on.

This parameter should specify a point layer generated by geocoding your customer records. It should be specified with a FeatureSet or FolderItem property and should contain the "Loc_name" attribute field whose value contains the match level of customer addresses geocoding.


Implementation
    public function get customerLayer():PointLayer
    public function set customerLayer(value:PointLayer):void

See also

Constructor Detail
MatchLevelSummaryReportParameters()Constructor
public function MatchLevelSummaryReportParameters()

Creates a new instance of the MatchLevelSummaryReportParameters class.

Examples
ActionScript to create MatchLevelSummaryReportParameters and then use in a Match Level Summary Report task:
                     
     var parameters : MatchLevelSummaryReportParameters = new MatchLevelSummaryReportParameters();
     
     // 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.
     // An array of PointRecord items is invalid for customerLayer.
     parameters.customerLayer = customers;
     
     // "customers" is the default value for customerDescription
     //parameters.customerDescription = "customers";
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
     
     matchLevelSummaryReportTask.execute(parameters, new Responder(resultHandler, faultHandler));