ReportParameters (Plugins 9.0.00-SNAPSHOT API)

java.lang.Object
- com.bmc.arsys.arreporting.ReportParameters

public class ReportParameters
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static String AR_DESIGNER

static String BIRT_DESIGNER

static String REPORT_DESIGNER

Fields
Modifier and Type	Field and Description
`static String`	`AR_DESIGNER`
`static String`	`BIRT_DESIGNER`
`static String`	`REPORT_DESIGNER`

Constructor Summary

Constructors
Constructor and Description

ReportParameters()

Constructors
Constructor and Description
`ReportParameters()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addField(FieldInfo field)`
`void`	`addGroup(FieldInfo group)`
`void`	`clearFields()`
`void`	`clearGroups()`
`Aggregation`	`getAggregation()`
`int`	`getCategoryField()`
`String`	`getCategoryLabel()`
`ChartType`	`getChartType()`
`String`	`getDescription()`
`String`	`getEncodedPrimaryQual()`
`String`	`getEncodedSecondaryQual()`
`String`	`getEntryId()`
`FieldInfo`	`getField(int fieldId)`
`int`	`getFieldDataType(int fieldId)`
`String`	`getFieldName(int fieldId)`
`List<FieldInfo>`	`getFields()` Gets an unmodifiable list of the fields in the report
`String`	`getFooter()`
`String`	`getForm()`
`List<FieldInfo>`	`getGroups()`
`int`	`getMaxRecords()`
`String`	`getMidtierUrl()`
`String`	`getName()`
`OutputFormat`	`getOutputFormat()`
`Properties`	`getProperties()`
`String`	`getQualification()`
`String`	`getReportFile()`
`String`	`getReportSet()`
`String`	`getResultList()`
`int`	`getSeriesField()`
`String`	`getSeriesLabel()`
`ReportStyle`	`getStyle()`
`String`	`getTitle()`
`ReportType`	`getType()`
`int`	`getVuiId()`
`boolean`	`isForcePNG()`
`boolean`	`isIncludeChart()`
`boolean`	`isIncludeList()`
`boolean`	`isOverrideQualification()`
`void`	`removeField(FieldInfo field)`
`void`	`removeField(int fieldId)`
`void`	`removeGroup(FieldInfo group)`
`void`	`removeGroup(int groupId)`
`void`	`setAggregation(Aggregation aggregation)`
`void`	`setCategoryField(int fieldId)`
`void`	`setChartType(ChartType chartType)`
`void`	`setEntryId(String entryId)`
`void`	`setFooter(String footer)`
`void`	`setForcePNG(boolean forcePNG)`
`void`	`setForm(String form)`
`void`	`setMaxRecords(int maxRecords)`
`void`	`setMidtierUrl(String midtierUrl)`
`void`	`setOutputFormat(OutputFormat format)`
`void`	`setOverrideQualification(boolean overrideQualification)`
`void`	`setProperties(Properties properties)`
`void`	`setQualification(String qualification)`
`void`	`setReportFile(String reportFile)`
`void`	`setReportSet(String reportSet)`
`void`	`setResultList(String resultList)` Sets the specific entries to use in a report.
`void`	`setSeriesField(int fieldId)`
`void`	`setStyle(ReportStyle reportStyle)`
`void`	`setType(ReportType type)`

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

Field Detail
- REPORT_DESIGNER
```
public static final String REPORT_DESIGNER
```
  See Also:
  Constant Field Values
- BIRT_DESIGNER
```
public static final String BIRT_DESIGNER
```
  See Also:
  Constant Field Values
- AR_DESIGNER
```
public static final String AR_DESIGNER
```
  See Also:
  Constant Field Values

Constructor Detail
- ReportParameters
```
public ReportParameters()
```

Method Detail

getEncodedPrimaryQual
```
public String getEncodedPrimaryQual()
```

getEncodedSecondaryQual

public String getEncodedSecondaryQual()

getTitle
```
public String getTitle()
```

getFooter
```
public String getFooter()
```

setFooter
```
public void setFooter(String footer)
```

getFields
```
public List<FieldInfo> getFields()
```
Gets an unmodifiable list of the fields in the report

Returns:

addField

public void addField(FieldInfo field)

removeField

public void removeField(FieldInfo field)

getField

public FieldInfo getField(int fieldId)

removeField
```
public void removeField(int fieldId)
```

addGroup

public void addGroup(FieldInfo group)

removeGroup

public void removeGroup(FieldInfo group)

removeGroup
```
public void removeGroup(int groupId)
```

getGroups
```
public List<FieldInfo> getGroups()
```

setType
```
public void setType(ReportType type)
```

getType
```
public ReportType getType()
```

setMaxRecords

public void setMaxRecords(int maxRecords)

getMaxRecords
```
public int getMaxRecords()
```

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

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

setReportSet

public void setReportSet(String reportSet)

getReportSet
```
public String getReportSet()
```

setProperties

public void setProperties(Properties properties)

getProperties
```
public Properties getProperties()
```

clearFields
```
public void clearFields()
```

clearGroups
```
public void clearGroups()
```

setMidtierUrl

public void setMidtierUrl(String midtierUrl)

getMidtierUrl
```
public String getMidtierUrl()
```

getSeriesField
```
public int getSeriesField()
```

getCategoryField
```
public int getCategoryField()
```

setSeriesField

public void setSeriesField(int fieldId)

setCategoryField

public void setCategoryField(int fieldId)

getForm
```
public String getForm()
```

setForm
```
public void setForm(String form)
```

getOutputFormat
```
public OutputFormat getOutputFormat()
```

setOutputFormat

public void setOutputFormat(OutputFormat format)

setReportFile

public void setReportFile(String reportFile)

getReportFile
```
public String getReportFile()
```

setOverrideQualification

public void setOverrideQualification(boolean overrideQualification)

isOverrideQualification

public boolean isOverrideQualification()

getEntryId
```
public String getEntryId()
```

setEntryId

public void setEntryId(String entryId)

setQualification

public void setQualification(String qualification)

getQualification
```
public String getQualification()
```

isIncludeList
```
public boolean isIncludeList()
```

isIncludeChart
```
public boolean isIncludeChart()
```

getVuiId
```
public int getVuiId()
```

setResultList
```
public void setResultList(String resultList)
```
Sets the specific entries to use in a report. Supplying this overrides any qualifications used in the report

Parameters:
resultList - A comma separated list of entry ids to use when running the report.

getResultList
```
public String getResultList()
```

setForcePNG

public void setForcePNG(boolean forcePNG)

isForcePNG
```
public boolean isForcePNG()
```

setChartType

public void setChartType(ChartType chartType)

getChartType
```
public ChartType getChartType()
```

setAggregation

public void setAggregation(Aggregation aggregation)

getAggregation
```
public Aggregation getAggregation()
```

setStyle

public void setStyle(ReportStyle reportStyle)

getStyle
```
public ReportStyle getStyle()
```

getSeriesLabel
```
public String getSeriesLabel()
```

getCategoryLabel
```
public String getCategoryLabel()
```

getFieldName

public String getFieldName(int fieldId)

getFieldDataType

public int getFieldDataType(int fieldId)

Class ReportParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REPORT_DESIGNER

BIRT_DESIGNER

AR_DESIGNER

Constructor Detail

ReportParameters

Method Detail

getEncodedPrimaryQual

getEncodedSecondaryQual

getTitle

getFooter

setFooter

getFields

addField

removeField

getField

removeField

addGroup

removeGroup

removeGroup

getGroups

setType

getType

setMaxRecords

getMaxRecords

getName

getDescription

setReportSet

getReportSet

setProperties

getProperties

clearFields

clearGroups

setMidtierUrl

getMidtierUrl

getSeriesField

getCategoryField

setSeriesField

setCategoryField

getForm

setForm

getOutputFormat

setOutputFormat

setReportFile

getReportFile

setOverrideQualification

isOverrideQualification

getEntryId

setEntryId

setQualification

getQualification

isIncludeList

isIncludeChart

getVuiId

setResultList

getResultList

setForcePNG

isForcePNG

setChartType

getChartType

setAggregation

getAggregation

setStyle

getStyle

getSeriesLabel

getCategoryLabel

getFieldName

getFieldDataType