Packagecom.esri.baserver.tasks.segmentation
Classpublic class ReportFromProfileParameters
InheritanceReportFromProfileParameters Inheritance StandardReportParameters Inheritance StandardReportParameters Inheritance BATaskParameters Inheritance Object

The ReportFromProfileParameters class provides input parameters for the Report from 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

ReportFromProfileTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BATaskParameters
 InheritedoutputReportItem : FolderItem
Configuration options for storing the output report in the repository.
StandardReportParameters
 InheritedoutputTypes : OutputTypes
Task output types.
BATaskParameters
  profile : ProfileData
Segmentation profile (required).
ReportFromProfileParameters
 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 ReportFromProfileParameters class.
ReportFromProfileParameters
Property Detail
profileproperty
profile:ProfileData

Segmentation profile (required).


Implementation
    public function get profile():ProfileData
    public function set profile(value:ProfileData):void
Constructor Detail
ReportFromProfileParameters()Constructor
public function ReportFromProfileParameters(profile:ProfileData = null)

Creates a new instance of the ReportFromProfileParameters class.

Parameters
profile:ProfileData (default = null) — Segmentation profile.
Examples
ActionScript to create ReportFromProfileParameters and then use in a Report from Profile task:
                     
     var parameters : ReportFromProfileParameters = new ReportFromProfileParameters();
     
     // The ProfileData type could take either data as an XML string
     // or as com.esri.baserver.FolderItem type, e.g.
     //var profile:FolderItem = new FolderItem(workspaceName, projectName, FolderType.SEGMENTATION_PROFILES, profileName);
     
     // Set a segmentation profile.
     parameters.profile = new ProfileData(profile);
     
     // Set report parameters. 
     parameters.standardReportOptions = new ReportOptions("PDF");
      
     reportFromProfileTask.execute(parameters, new Responder(resultHandler, faultHandler));