Packagecom.esri.baserver.tasks.reports
Classpublic class CustomerDemographicProfileParameters
InheritanceCustomerDemographicProfileParameters Inheritance StandardReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The CustomerDemographicProfileParameters class provides input parameters for the Customer Demographic Profile 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

CustomerDemographicProfileTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
  customers : PointLayer
A point layer containing point features which represent the locations of customers to get the demographic profile for (required).
CustomerDemographicProfileParameters
  geographyLayerID : String
ID of a standard geography layer to get demography from (requred).
CustomerDemographicProfileParameters
 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
  
CustomerDemographicProfileParameters(customers:PointLayer = null, geographyLayerID:String = null)
Creates a new instance of the CustomerDemographicProfileParameters class.
CustomerDemographicProfileParameters
Property Detail
customersproperty
customers:PointLayer

A point layer containing point features which represent the locations of customers to get the demographic profile for (required).


Implementation
    public function get customers():PointLayer
    public function set customers(value:PointLayer):void
geographyLayerIDproperty 
geographyLayerID:String

ID of a standard geography layer to get demography from (requred).


Implementation
    public function get geographyLayerID():String
    public function set geographyLayerID(value:String):void
Constructor Detail
CustomerDemographicProfileParameters()Constructor
public function CustomerDemographicProfileParameters(customers:PointLayer = null, geographyLayerID:String = null)

Creates a new instance of the CustomerDemographicProfileParameters class.

Parameters
customers:PointLayer (default = null) — The customer layer used to get the demographic profile for.
 
geographyLayerID:String (default = null) — ID of a standard geography layer to get demography from.
Examples
ActionScript to create CustomerDemographicProfileParameters and then use in a Customer Demographic Profile task:
                     
     var parameters : CustomerDemographicProfileParameters = new CustomerDemographicProfileParameters();
     
     // 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 ID of a geography layer to get demography from.
     parameters.dataLayerID = "US.BlockGroups";
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
      
     customerDemographicProfileTask.execute(parameters, new Responder(resultHandler, faultHandler));