Report (force-metadata-api 40.0.0 API)

java.lang.Object
- com.sforce.soap.metadata.Metadata
- - com.sforce.soap.metadata.Report

All Implemented Interfaces:

XMLizable
```
public class Report
extends Metadata
```
This is a generated class for the SObject Enterprise API. Do not edit this file, as your changes will be lost.

Constructor Summary

Constructors
Constructor and Description

Report()
Constructor

Constructors
Constructor and Description
`Report()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReportAggregate[]`	`getAggregates()`
`Report[]`	`getBlock()`
`ReportBlockInfo`	`getBlockInfo()`
`ReportBucketField[]`	`getBuckets()`
`ReportChart`	`getChart()`
`ReportColorRange[]`	`getColorRanges()`
`ReportColumn[]`	`getColumns()`
`ReportCrossFilter[]`	`getCrossFilters()`
`CurrencyIsoCode`	`getCurrency()`
`ReportDataCategoryFilter[]`	`getDataCategoryFilters()`
`String`	`getDescription()`
`String`	`getDivision()`
`ReportFilter`	`getFilter()`
`String`	`getFolderName()`
`ReportFormat`	`getFormat()`
`ReportGrouping[]`	`getGroupingsAcross()`
`ReportGrouping[]`	`getGroupingsDown()`
`ReportHistoricalSelector`	`getHistoricalSelector()`
`String`	`getName()`
`int`	`getNumSubscriptions()`
`ReportParam[]`	`getParams()`
`String`	`getReportType()`
`String`	`getRoleHierarchyFilter()`
`int`	`getRowLimit()`
`String`	`getScope()`
`boolean`	`getShowCurrentDate()`
`boolean`	`getShowDetails()`
`String`	`getSortColumn()`
`SortOrder`	`getSortOrder()`
`String`	`getTerritoryHierarchyFilter()`
`ReportTimeFrameFilter`	`getTimeFrameFilter()`
`String`	`getUserFilter()`
`boolean`	`isShowCurrentDate()`
`boolean`	`isShowDetails()`
`void`	`load(XmlInputStream __in, TypeMapper __typeMapper)`
`protected void`	`loadFields(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setAggregates(ReportAggregate[] aggregates)`
`protected void`	`setAggregates(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setBlock(Report[] block)`
`protected void`	`setBlock(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setBlockInfo(ReportBlockInfo blockInfo)`
`protected void`	`setBlockInfo(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setBuckets(ReportBucketField[] buckets)`
`protected void`	`setBuckets(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setChart(ReportChart chart)`
`protected void`	`setChart(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setColorRanges(ReportColorRange[] colorRanges)`
`protected void`	`setColorRanges(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setColumns(ReportColumn[] columns)`
`protected void`	`setColumns(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setCrossFilters(ReportCrossFilter[] crossFilters)`
`protected void`	`setCrossFilters(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setCurrency(CurrencyIsoCode currency)`
`protected void`	`setCurrency(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDataCategoryFilters(ReportDataCategoryFilter[] dataCategoryFilters)`
`protected void`	`setDataCategoryFilters(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDescription(String description)`
`protected void`	`setDescription(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setDivision(String division)`
`protected void`	`setDivision(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFilter(ReportFilter filter)`
`protected void`	`setFilter(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFolderName(String folderName)`
`protected void`	`setFolderName(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setFormat(ReportFormat format)`
`protected void`	`setFormat(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setGroupingsAcross(ReportGrouping[] groupingsAcross)`
`protected void`	`setGroupingsAcross(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setGroupingsDown(ReportGrouping[] groupingsDown)`
`protected void`	`setGroupingsDown(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setHistoricalSelector(ReportHistoricalSelector historicalSelector)`
`protected void`	`setHistoricalSelector(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setName(String name)`
`protected void`	`setName(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setNumSubscriptions(int numSubscriptions)`
`protected void`	`setNumSubscriptions(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setParams(ReportParam[] params)`
`protected void`	`setParams(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setReportType(String reportType)`
`protected void`	`setReportType(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRoleHierarchyFilter(String roleHierarchyFilter)`
`protected void`	`setRoleHierarchyFilter(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setRowLimit(int rowLimit)`
`protected void`	`setRowLimit(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setScope(String scope)`
`protected void`	`setScope(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setShowCurrentDate(boolean showCurrentDate)`
`protected void`	`setShowCurrentDate(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setShowDetails(boolean showDetails)`
`protected void`	`setShowDetails(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSortColumn(String sortColumn)`
`protected void`	`setSortColumn(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setSortOrder(SortOrder sortOrder)`
`protected void`	`setSortOrder(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setTerritoryHierarchyFilter(String territoryHierarchyFilter)`
`protected void`	`setTerritoryHierarchyFilter(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setTimeFrameFilter(ReportTimeFrameFilter timeFrameFilter)`
`protected void`	`setTimeFrameFilter(XmlInputStream __in, TypeMapper __typeMapper)`
`void`	`setUserFilter(String userFilter)`
`protected void`	`setUserFilter(XmlInputStream __in, TypeMapper __typeMapper)`
`String`	`toString()`
`void`	`write(QName __element, XmlOutputStream __out, TypeMapper __typeMapper)`
`protected void`	`writeFields(XmlOutputStream __out, TypeMapper __typeMapper)`

Methods inherited from class com.sforce.soap.metadata.Metadata
getFullName, setFullName, setFullName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- Report
```
public Report()
```
  Constructor

Method Detail

getAggregates

public ReportAggregate[] getAggregates()

setAggregates

public void setAggregates(ReportAggregate[] aggregates)

setAggregates

protected void setAggregates(XmlInputStream __in,
                             TypeMapper __typeMapper)
                      throws IOException,
                             ConnectionException

Throws:: IOException; ConnectionException

getBlock
```
public Report[] getBlock()
```

setBlock
```
public void setBlock(Report[] block)
```

setBlock

protected void setBlock(XmlInputStream __in,
                        TypeMapper __typeMapper)
                 throws IOException,
                        ConnectionException

Throws:: IOException; ConnectionException

getBlockInfo
```
public ReportBlockInfo getBlockInfo()
```

setBlockInfo

public void setBlockInfo(ReportBlockInfo blockInfo)

setBlockInfo

protected void setBlockInfo(XmlInputStream __in,
                            TypeMapper __typeMapper)
                     throws IOException,
                            ConnectionException

Throws:: IOException; ConnectionException

getBuckets

public ReportBucketField[] getBuckets()

setBuckets

public void setBuckets(ReportBucketField[] buckets)

setBuckets

protected void setBuckets(XmlInputStream __in,
                          TypeMapper __typeMapper)
                   throws IOException,
                          ConnectionException

Throws:: IOException; ConnectionException

getChart
```
public ReportChart getChart()
```

setChart

public void setChart(ReportChart chart)

setChart

protected void setChart(XmlInputStream __in,
                        TypeMapper __typeMapper)
                 throws IOException,
                        ConnectionException

Throws:: IOException; ConnectionException

getColorRanges

public ReportColorRange[] getColorRanges()

setColorRanges

public void setColorRanges(ReportColorRange[] colorRanges)

setColorRanges

protected void setColorRanges(XmlInputStream __in,
                              TypeMapper __typeMapper)
                       throws IOException,
                              ConnectionException

Throws:: IOException; ConnectionException

getColumns
```
public ReportColumn[] getColumns()
```

setColumns

public void setColumns(ReportColumn[] columns)

setColumns

protected void setColumns(XmlInputStream __in,
                          TypeMapper __typeMapper)
                   throws IOException,
                          ConnectionException

Throws:: IOException; ConnectionException

getCrossFilters

public ReportCrossFilter[] getCrossFilters()

setCrossFilters

public void setCrossFilters(ReportCrossFilter[] crossFilters)

setCrossFilters

protected void setCrossFilters(XmlInputStream __in,
                               TypeMapper __typeMapper)
                        throws IOException,
                               ConnectionException

Throws:: IOException; ConnectionException

getCurrency
```
public CurrencyIsoCode getCurrency()
```

setCurrency

public void setCurrency(CurrencyIsoCode currency)

setCurrency

protected void setCurrency(XmlInputStream __in,
                           TypeMapper __typeMapper)
                    throws IOException,
                           ConnectionException

Throws:: IOException; ConnectionException

getDataCategoryFilters

public ReportDataCategoryFilter[] getDataCategoryFilters()

setDataCategoryFilters

public void setDataCategoryFilters(ReportDataCategoryFilter[] dataCategoryFilters)

setDataCategoryFilters

protected void setDataCategoryFilters(XmlInputStream __in,
                                      TypeMapper __typeMapper)
                               throws IOException,
                                      ConnectionException

Throws:: IOException; ConnectionException

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

setDescription

protected void setDescription(XmlInputStream __in,
                              TypeMapper __typeMapper)
                       throws IOException,
                              ConnectionException

Throws:: IOException; ConnectionException

getDivision
```
public String getDivision()
```

setDivision

public void setDivision(String division)

setDivision

protected void setDivision(XmlInputStream __in,
                           TypeMapper __typeMapper)
                    throws IOException,
                           ConnectionException

Throws:: IOException; ConnectionException

getFilter
```
public ReportFilter getFilter()
```

setFilter

public void setFilter(ReportFilter filter)

setFilter

protected void setFilter(XmlInputStream __in,
                         TypeMapper __typeMapper)
                  throws IOException,
                         ConnectionException

Throws:: IOException; ConnectionException

getFolderName
```
public String getFolderName()
```

setFolderName

public void setFolderName(String folderName)

setFolderName

protected void setFolderName(XmlInputStream __in,
                             TypeMapper __typeMapper)
                      throws IOException,
                             ConnectionException

Throws:: IOException; ConnectionException

getFormat
```
public ReportFormat getFormat()
```

setFormat

public void setFormat(ReportFormat format)

setFormat

protected void setFormat(XmlInputStream __in,
                         TypeMapper __typeMapper)
                  throws IOException,
                         ConnectionException

Throws:: IOException; ConnectionException

getGroupingsAcross

public ReportGrouping[] getGroupingsAcross()

setGroupingsAcross

public void setGroupingsAcross(ReportGrouping[] groupingsAcross)

setGroupingsAcross

protected void setGroupingsAcross(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getGroupingsDown

public ReportGrouping[] getGroupingsDown()

setGroupingsDown

public void setGroupingsDown(ReportGrouping[] groupingsDown)

setGroupingsDown

protected void setGroupingsDown(XmlInputStream __in,
                                TypeMapper __typeMapper)
                         throws IOException,
                                ConnectionException

Throws:: IOException; ConnectionException

getHistoricalSelector

public ReportHistoricalSelector getHistoricalSelector()

setHistoricalSelector

public void setHistoricalSelector(ReportHistoricalSelector historicalSelector)

setHistoricalSelector

protected void setHistoricalSelector(XmlInputStream __in,
                                     TypeMapper __typeMapper)
                              throws IOException,
                                     ConnectionException

Throws:: IOException; ConnectionException

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

setName

protected void setName(XmlInputStream __in,
                       TypeMapper __typeMapper)
                throws IOException,
                       ConnectionException

Throws:: IOException; ConnectionException

getNumSubscriptions
```
public int getNumSubscriptions()
```

setNumSubscriptions

public void setNumSubscriptions(int numSubscriptions)

setNumSubscriptions

protected void setNumSubscriptions(XmlInputStream __in,
                                   TypeMapper __typeMapper)
                            throws IOException,
                                   ConnectionException

Throws:: IOException; ConnectionException

getParams
```
public ReportParam[] getParams()
```

setParams

public void setParams(ReportParam[] params)

setParams

protected void setParams(XmlInputStream __in,
                         TypeMapper __typeMapper)
                  throws IOException,
                         ConnectionException

Throws:: IOException; ConnectionException

getReportType
```
public String getReportType()
```

setReportType

public void setReportType(String reportType)

setReportType

protected void setReportType(XmlInputStream __in,
                             TypeMapper __typeMapper)
                      throws IOException,
                             ConnectionException

Throws:: IOException; ConnectionException

getRoleHierarchyFilter

public String getRoleHierarchyFilter()

setRoleHierarchyFilter

public void setRoleHierarchyFilter(String roleHierarchyFilter)

setRoleHierarchyFilter

protected void setRoleHierarchyFilter(XmlInputStream __in,
                                      TypeMapper __typeMapper)
                               throws IOException,
                                      ConnectionException

Throws:: IOException; ConnectionException

getRowLimit
```
public int getRowLimit()
```

setRowLimit

public void setRowLimit(int rowLimit)

setRowLimit

protected void setRowLimit(XmlInputStream __in,
                           TypeMapper __typeMapper)
                    throws IOException,
                           ConnectionException

Throws:: IOException; ConnectionException

getScope
```
public String getScope()
```

setScope
```
public void setScope(String scope)
```

setScope

protected void setScope(XmlInputStream __in,
                        TypeMapper __typeMapper)
                 throws IOException,
                        ConnectionException

Throws:: IOException; ConnectionException

getShowCurrentDate
```
public boolean getShowCurrentDate()
```

isShowCurrentDate
```
public boolean isShowCurrentDate()
```

setShowCurrentDate

public void setShowCurrentDate(boolean showCurrentDate)

setShowCurrentDate

protected void setShowCurrentDate(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getShowDetails
```
public boolean getShowDetails()
```

isShowDetails
```
public boolean isShowDetails()
```

setShowDetails

public void setShowDetails(boolean showDetails)

setShowDetails

protected void setShowDetails(XmlInputStream __in,
                              TypeMapper __typeMapper)
                       throws IOException,
                              ConnectionException

Throws:: IOException; ConnectionException

getSortColumn
```
public String getSortColumn()
```

setSortColumn

public void setSortColumn(String sortColumn)

setSortColumn

protected void setSortColumn(XmlInputStream __in,
                             TypeMapper __typeMapper)
                      throws IOException,
                             ConnectionException

Throws:: IOException; ConnectionException

getSortOrder
```
public SortOrder getSortOrder()
```

setSortOrder

public void setSortOrder(SortOrder sortOrder)

setSortOrder

protected void setSortOrder(XmlInputStream __in,
                            TypeMapper __typeMapper)
                     throws IOException,
                            ConnectionException

Throws:: IOException; ConnectionException

getTerritoryHierarchyFilter

public String getTerritoryHierarchyFilter()

setTerritoryHierarchyFilter

public void setTerritoryHierarchyFilter(String territoryHierarchyFilter)

setTerritoryHierarchyFilter

protected void setTerritoryHierarchyFilter(XmlInputStream __in,
                                           TypeMapper __typeMapper)
                                    throws IOException,
                                           ConnectionException

Throws:: IOException; ConnectionException

getTimeFrameFilter

public ReportTimeFrameFilter getTimeFrameFilter()

setTimeFrameFilter

public void setTimeFrameFilter(ReportTimeFrameFilter timeFrameFilter)

setTimeFrameFilter

protected void setTimeFrameFilter(XmlInputStream __in,
                                  TypeMapper __typeMapper)
                           throws IOException,
                                  ConnectionException

Throws:: IOException; ConnectionException

getUserFilter
```
public String getUserFilter()
```

setUserFilter

public void setUserFilter(String userFilter)

setUserFilter

protected void setUserFilter(XmlInputStream __in,
                             TypeMapper __typeMapper)
                      throws IOException,
                             ConnectionException

Throws:: IOException; ConnectionException

write

public void write(QName __element,
                  XmlOutputStream __out,
                  TypeMapper __typeMapper)
           throws IOException

Specified by:: write in interface XMLizable
Overrides:: write in class Metadata
Throws:: IOException

writeFields

protected void writeFields(XmlOutputStream __out,
                           TypeMapper __typeMapper)
                    throws IOException

Overrides:: writeFields in class Metadata
Throws:: IOException

load

public void load(XmlInputStream __in,
                 TypeMapper __typeMapper)
          throws IOException,
                 ConnectionException

Specified by:: load in interface XMLizable
Overrides:: load in class Metadata
Throws:: IOException; ConnectionException

loadFields

protected void loadFields(XmlInputStream __in,
                          TypeMapper __typeMapper)
                   throws IOException,
                          ConnectionException

Overrides:: loadFields in class Metadata
Throws:: IOException; ConnectionException

toString
```
public String toString()
```
Overrides:

toString in class Metadata

Class Report

Constructor Summary

Method Summary

Methods inherited from class com.sforce.soap.metadata.Metadata

Methods inherited from class java.lang.Object

Constructor Detail

Report

Method Detail

getAggregates

setAggregates

setAggregates

getBlock

setBlock

setBlock

getBlockInfo

setBlockInfo

setBlockInfo

getBuckets

setBuckets

setBuckets

getChart

setChart

setChart

getColorRanges

setColorRanges

setColorRanges

getColumns

setColumns

setColumns

getCrossFilters

setCrossFilters

setCrossFilters

getCurrency

setCurrency

setCurrency

getDataCategoryFilters

setDataCategoryFilters

setDataCategoryFilters

getDescription

setDescription

setDescription

getDivision

setDivision

setDivision

getFilter

setFilter

setFilter

getFolderName

setFolderName

setFolderName

getFormat

setFormat

setFormat

getGroupingsAcross

setGroupingsAcross

setGroupingsAcross

getGroupingsDown

setGroupingsDown

setGroupingsDown

getHistoricalSelector

setHistoricalSelector

setHistoricalSelector

getName

setName

setName

getNumSubscriptions

setNumSubscriptions

setNumSubscriptions

getParams

setParams

setParams

getReportType

setReportType

setReportType

getRoleHierarchyFilter

setRoleHierarchyFilter

setRoleHierarchyFilter

getRowLimit

setRowLimit

setRowLimit