Packagecom.esri.bacore
Classpublic class ReportTemplateInfo
InheritanceReportTemplateInfo Inheritance Object

The ReportTemplateInfo class contains information about a report template including its title, category, output formats, and name. Additionally, a dataset ID is associated with every template when the activeDatasetID is specified in a calling task.

See also

GetReportTemplatesTask - Business Analyst Online
GetReportTemplatesTask - Business Analyst Server

Public Properties
 PropertyDefined By
  category : String
[read-only] Report category associated with this template.
ReportTemplateInfo
  datasetID : String
[read-only] ID of the dataset owning this template.
ReportTemplateInfo
  formats : Array
[read-only] Array of supported formats for this report template.
ReportTemplateInfo
  headers : Array
[read-only] Array of supported header options for this report template.
ReportTemplateInfo
  name : String
[read-only] Report name associated with this template.
ReportTemplateInfo
  title : String
[read-only] Report title associated with this template.
ReportTemplateInfo
Public Methods
 MethodDefined By
  
ReportTemplateInfo(name:String, category:String, title:String, formats:Array, headers:Array, datasetID:String = null)
Creates a new instance of the ReportTemplateInfo class.
ReportTemplateInfo
Property Detail
categoryproperty
category:String  [read-only]

Report category associated with this template.


Implementation
    public function get category():String
datasetIDproperty 
datasetID:String  [read-only]

Since : Business Analyst API for Flex 3.0.

ID of the dataset owning this template.


Implementation
    public function get datasetID():String
formatsproperty 
formats:Array  [read-only]

Array of supported formats for this report template.


Implementation
    public function get formats():Array
headersproperty 
headers:Array  [read-only]

Array of supported header options for this report template. This property is used in the Business Analyst Server API only.


Implementation
    public function get headers():Array
nameproperty 
name:String  [read-only]

Report name associated with this template.


Implementation
    public function get name():String
titleproperty 
title:String  [read-only]

Report title associated with this template.


Implementation
    public function get title():String
Constructor Detail
ReportTemplateInfo()Constructor
public function ReportTemplateInfo(name:String, category:String, title:String, formats:Array, headers:Array, datasetID:String = null)

Creates a new instance of the ReportTemplateInfo class.

Parameters
name:String — Report name associated with this template.
 
category:String — Report category associated with this template.
 
title:String — Report title associated with this template.
 
formats:Array — Array of supported formats for this report template.
 
headers:Array — Array of supported header options for this report template.
 
datasetID:String (default = null) — ID of the dataset owning this template (since Business Analyst API for Flex 3.0).



© 2011-2012 Esri, Inc. All rights reserved.

Tue Sep 4 2012, 10:17 PM +07:00