org.apertereports.common.xml.config
Class ReportConfig

java.lang.Object
  org.apertereports.common.xml.config.ReportConfig

All Implemented Interfaces:

Serializable

public class ReportConfig
extends Object
implements Serializable

Represents a dashboard report config. The config is later stored in portlet preferences as marshaled string.

The parameters contain:

• reportId - database identifier of a report template
• cacheTimeout - dashboard display cache timeout
• cyclicReportId - database identifier of a cyclic report (if specified)
• allowRefresh - should manual refresh be allowed
• allowedFormats - coma separated list of allowed formats (i.e. PDF, XLS etc)
• parameters - a list of report configuration parameters set in dashboard preferences

See Also:

Serialized Form

Constructor Summary

ReportConfig()

ReportConfig(Integer id, Integer reportId, Integer cacheTimeout, Long cyclicReportId, Boolean allowRefresh, String allowedFormats, List<ReportConfigParameter> parameters)

Method Summary

String	getAllowedFormats()
List<String>	getAllowedFormatsAsList()
Boolean	getAllowRefresh()
Integer	getCacheTimeout()
Long	getCyclicReportId()
Integer	getId()
List<ReportConfigParameter>	getParameters()
Integer	getReportId()
void	setAllowedFormats(String allowedFormats)
void	setAllowedFormatsFromList(List<String> allowedFormats) Sets the coma separated list of allowed formats.
void	setAllowRefresh(Boolean allowRefresh)
void	setCacheTimeout(Integer cacheTimeout)
void	setCyclicReportId(Long cyclicReportId)
void	setId(Integer id)
void	setParameters(List<ReportConfigParameter> parameters)
void	setReportId(Integer reportId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportConfig

public ReportConfig()

ReportConfig

public ReportConfig(Integer id,
                    Integer reportId,
                    Integer cacheTimeout,
                    Long cyclicReportId,
                    Boolean allowRefresh,
                    String allowedFormats,
                    List<ReportConfigParameter> parameters)

Method Detail

getId

public Integer getId()

setId

public void setId(Integer id)

getReportId

public Integer getReportId()

setReportId

public void setReportId(Integer reportId)

getCacheTimeout

public Integer getCacheTimeout()

setCacheTimeout

public void setCacheTimeout(Integer cacheTimeout)

getCyclicReportId

public Long getCyclicReportId()

setCyclicReportId

public void setCyclicReportId(Long cyclicReportId)

getAllowRefresh

public Boolean getAllowRefresh()

setAllowRefresh

public void setAllowRefresh(Boolean allowRefresh)

getAllowedFormatsAsList

public List<String> getAllowedFormatsAsList()

getAllowedFormats

public String getAllowedFormats()

setAllowedFormats

public void setAllowedFormats(String allowedFormats)

setAllowedFormatsFromList

public void setAllowedFormatsFromList(List<String> allowedFormats)

Sets the coma separated list of allowed formats.

Parameters:

allowedFormats - A list of values

getParameters

public List<ReportConfigParameter> getParameters()

setParameters

public void setParameters(List<ReportConfigParameter> parameters)