com.hof.mi.web.service

Class i4Report

java.lang.Object

com.hof.mi.web.service.i4Report

All Implemented Interfaces:

java.io.Serializable

public class i4Report
extends java.lang.Object
implements java.io.Serializable

i4report is an instance of a Yellowfin report stored in memory. This report is populated from an external Yellowfin Server via web-services. The i4Report is created using ReportServiceClient.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SORT_ASCENDING Constant value representing ascending sort.
static int	SORT_DESCENDING Constant value representing descending sort.

Constructor Summary

Constructors

Constructor and Description
i4Report(ReportServiceResponse rs, java.util.HashMap Storage)

Method Summary

Modifier and Type	Method and Description
boolean	broadcastReport(java.lang.String Subject, java.lang.String content, java.lang.String[] recipients, java.lang.String attachmentType)
boolean	broadcastReport(java.lang.String Subject, java.lang.String content, java.lang.String[] recipients, java.lang.String attachmentType, java.lang.String distributeMethod)
boolean	canUserSubscribe()
boolean	deleteComment(java.lang.Integer CommentId)
boolean	distributeReport(java.lang.String[] recipients)
boolean	distributeReport(java.lang.String[] recipients, java.lang.String message)
boolean	filterHasDependantChildren(java.lang.Integer filterId) Returns whether or not a filter has child filters that are dependant on it.
java.lang.Integer	getAbsoluteTableWidth()
java.lang.String	getAuthor()
java.lang.String	getAuthoringMode() How the report was authored: "JAVA" (Standard drag-and-drop builder), "SQL" (Freehand SQL), "JASPER", "BIRT".
java.lang.Integer	getAverageRunTime()
java.lang.String	getBinaryURL() Get URL for binary link.
java.util.HashMap	getBlobs() Get binary objects
BreadCrumb[]	getBreadcrumbs()
java.lang.Boolean	getCanDrill()
java.lang.String	getCategory()
java.lang.Integer	getChartHeight()
java.lang.String	getChartPlacementCode()
java.util.HashMap	getCharts() Get charts returned with the report
java.lang.Integer	getChartScale()
java.lang.Integer	getChartWidth()
java.lang.String	getColumnDisplayName(java.lang.String colName) Returns the display name for a column.
ReportSchema[]	getColumns() Retrieve columns from report object
java.lang.String	getColumnType(java.lang.String ColumnName) Get the column type.
ReportComment[]	getComments()
java.lang.String	getContentType() Get the Content Type (mime-type) of the report
java.lang.String	getDataFormatterType() Data formatter type to use.
java.lang.String	getDataOutput() Data output type: "COLUMN", "ROW", "PIVOT"
java.lang.String	getDatasource()
java.lang.Integer	getDisplayedReportId() After running a report, this will return the id of the report displayed.
java.lang.String	getDrillCode()
java.lang.String	getExecutionObject() Get the Execution Object Name
ReportSchema	getFilterColumn(java.lang.Integer filterId) Gets the ReportSchema object for a filter.
java.lang.String[]	getFilterColumns() Deprecated. use getFilterIds() or getFilterSchema()
java.lang.Integer[]	getFilterIds() Get the filterIds for all required filters
ReportSchema[]	getFilterSchema() Get the column schema objects for all required filters
java.lang.String	getFilterType(java.lang.String ColumnName) Deprecated. use getFilterTypeById(Integer)
java.lang.String	getFilterTypeById(java.lang.Integer filterId) Get the column type for a filter.
java.lang.String	getFilterValue(java.lang.String ColumnName, java.lang.String DataValue) Deprecated. use getFilterValueById(Integer)
java.lang.String	getFilterValueById(java.lang.Integer filterId) Get the stored value of a user prompt filter.
java.lang.Boolean	getFitTableWidth()
java.lang.String	getFormatCode() Get the Format Code of Report
GISMap[]	getGisMap()
GMap[]	getGoogleMaps()
java.lang.String	getImageType() Returns the image type used for rendering charts
java.lang.String	getImageURL() Returns URL for image generation.
java.lang.String	getLanguageCode()
java.lang.String	getLastModifiedDate()
java.lang.Integer	getLastRunDuration() Get last run duration of report
java.lang.String	getLastRunStatus() Get last run status
java.math.BigDecimal	getLastRunTime() Get last run time
java.lang.String	getLinkFormatterClass()
java.lang.String	getLinkURL() Returns URL for link generation.
java.lang.String[]	getMessages() Get status messages generated by Yellowfin
java.lang.String	getMultiReportTag()
int	getPort() Get TCPIP port that is being used for connecting to webservices.
java.lang.String	getPreReportRunFilter()
RelatedReports	getRelatedReports()
java.lang.String	getReportDescription()
java.lang.Integer	getReportId() Get internal Yellowfin report Id
java.lang.String	getReportName() Get the Report Name
java.lang.String[]	getReportOptions()
ReportPageSelection[]	getReportPageSelection()
java.lang.String	getReportStyle() Returns the CSS style used for this report.
ReportTabSelection[]	getReportTabSelection()
java.lang.String	getReportTemplate() Report template: "REPORT", "CHART", "REPORTANDCHART"
java.lang.Integer	getReportUsage()
java.lang.String	getRequestStatus() Get last webservices request status
java.lang.Integer	getSelectedSortColumn()
java.lang.Integer	getSelectedSortType()
SeriesSelection[]	getSeriesSelection()
SortableTableColumn[]	getSortableColumns()
java.lang.String	getSubCategory()
ScheduleRecord	getSubscriptionSchedule()
java.lang.String	getTags()
TimeAggregationSelection[]	getTimeAggregationSelection()
TimeSliderSelection[]	getTimeSliderSelection()
java.lang.String	getUsername() Get webservices request username
java.lang.String	getViewName()
int	getVisibleColumns() Get number of visible columns
java.lang.String	getWebServicesURL() Get webservices request URL
boolean	isActiveCharts()
boolean	isAllowInteractiveGoogleMaps()
boolean	isDashboardEnabled() Is the report enabled for dashboard use?
boolean	isGisNavigation()
boolean	isMultiCharts()
java.lang.Boolean	isPrivate()
boolean	isShowAlertImages() Get status of Show Alert Images
boolean	isShowAlertLegendTable()
boolean	isShowAlerts() Get status of Alerts
boolean	isShowCharts() Get status of ShowCharts
boolean	isShowCoDisplay()
boolean	isShowDrillDownStack()
boolean	isShowDrillThroughStack()
boolean	isShowLinks() Get status of ShowLinks
boolean	isShowPageSelection()
boolean	isShowSeriesSelection()
boolean	isShowSort() Get status of ShowSort
boolean	isShowTabs()
boolean	isShowTimeSlider()
boolean	isShowTimeUnitSelection()
boolean	isShowTitle() Get status of ShowTitle
boolean	isSinglePage()
boolean	isTriggerJSGoogleMapsSetup()
boolean	populateComments()
boolean	populateDetails()
boolean	populateSubscription()
boolean	postComment(java.lang.Integer ParentCommentId, java.lang.String Comment)
boolean	postComment(java.lang.Integer ParentCommentId, java.lang.String Comment, java.lang.Integer authorId)
java.lang.String	render() Render the report.
byte[]	renderBinary() Render the report.
java.util.ArrayList	retrieveFilterPromptValues(java.lang.Integer filterId) Retrieves a list of options for a filter.
void	run() Run the report.
void	run(java.util.HashMap Storage) Run the report.
void	run(java.util.HashMap Storage, java.lang.String Type) Run the report.
void	run(java.util.HashMap Storage, java.lang.String Type, boolean multiChart)
void	runCommand(java.lang.String Command) Run a modification command against the report.
void	setAbsoluteTableWidth(java.lang.Integer absoluteTableWidth)
void	setActiveCharts(boolean activeCharts)
void	setAllowInteractiveGoogleMaps(boolean allowInteractiveGoogleMaps)
void	setBinaryURL(java.lang.String binaryURL) Set URL for binary link.
void	setBreadcrumbs(BreadCrumb[] breadcrumbs)
void	setCanDrill(java.lang.Boolean canDrill)
void	setCanUserSubscribe(boolean canUserSubscribe)
void	setChartHeight(java.lang.Integer chartHeight)
void	setChartPlacementCode(java.lang.String chartPlacementCode)
void	setCharts(java.util.HashMap charts) Set charts
void	setChartScale(java.lang.Integer chartScale)
void	setChartWidth(java.lang.Integer chartWidth)
void	setComments(ReportComment[] comments)
void	setDataFormatterType(java.lang.String dataFormatterType) Data formatter type to use
void	setDatasource(java.lang.String datasource)
void	setDrillCode(java.lang.String drillCode)
boolean	setFilter(java.lang.String ColumnName, java.lang.String DataValue) Deprecated. use setFilterById(Integer, String)
boolean	setFilterById(java.lang.Integer filterId, java.lang.String value) Set a user prompt filter.
boolean	setFilterOmittedById(java.lang.Integer filterId) Set a user prompt filter to be omitted.
void	setFitTableWidth(java.lang.Boolean fitTableWidth)
void	setGisMap(GISMap[] gisMap)
void	setGisNavigation(boolean gisNavigation)
void	setGoogleMaps(GMap[] googleMaps)
void	setImageType(java.lang.String imageType) Setes the image type used for rendering charts ("png", "jpg", "bmp", or "image/png", "image/jpeg", etc)
void	setImageURL(java.lang.String imageURL) Set URL for image generation.
void	setIsPrivate(java.lang.Boolean isPrivate)
void	setLanguageCode(java.lang.String languageCode)
void	setLastModifiedDate(java.lang.String lastModifiedDate)
void	setLinkFormatterClass(java.lang.String linkFormatterClass) Class type used to generate drill-anywhere links.
void	setLinkURL(java.lang.String linkURL) Set URL for link generation.
void	setMultiCharts(boolean multiCharts)
void	setMultiReportTag(java.lang.String multiReportTag)
void	setPreReportRunFilter(java.lang.String preReportRunFilter)
void	setRelatedReports(RelatedReports relatedReports)
void	setReportName(java.lang.String reportName) Set the Report Name (Used Internally)
void	setReportOptions(java.lang.String[] reportOptions)
void	setReportPageSelection(ReportPageSelection[] reportPageSelection)
void	setReportTabSelection(ReportTabSelection[] reportTabSelection)
void	setReportUsage(java.lang.Integer reportUsage)
void	setSelectedSortColumn(java.lang.Integer selectedSortColumn)
void	setSelectedSortType(java.lang.Integer selectedSortType)
void	setSeriesSelection(SeriesSelection[] seriesSelection)
void	setShowAlertImages(boolean showAlertImages) Show image based alerts in rendered HTML
void	setShowAlertLegendTable(boolean showAlertLegendTable)
void	setShowAlerts(boolean showAlerts) Show alerts in rendered report
void	setShowCharts(boolean showCharts) Show charts in rendered report
void	setShowCoDisplay(boolean showCoDisplay)
void	setShowDrillDownStack(boolean showDrillDownStack)
void	setShowDrillThroughStack(boolean showDrillThroughStack)
void	setShowLinks(boolean showLinks) Show links in rendered report
void	setShowPageSelection(boolean showPageSelection)
void	setShowSeriesSelection(boolean showSeriesSelection)
void	setShowSort(boolean showSort) Show sort links in rendered report
void	setShowTabs(boolean showTabs)
void	setShowTimeSlider(boolean showTimeSlider)
void	setShowTimeUnitSelection(boolean showTimeUnitSelection)
void	setShowTitle(boolean showTitle) Show title in rendered report
void	setSinglePage(boolean singlePage)
void	setSortableColumns(SortableTableColumn[] sortableColumns)
void	setSubscriptionSchedule(ScheduleRecord subscriptionSchedule)
void	setTags(java.lang.String tags)
void	setTimeAggregationSelection(TimeAggregationSelection[] timeAggregationSelection)
void	setTimeSliderSelection(TimeSliderSelection[] timeSliderSelection)
void	setTriggerJSGoogleMapsSetup(boolean triggerJSGoogleMapsSetup)
void	setViewName(java.lang.String viewName)
void	setVisibleColumns(int visibleColumns) Set visible column count (used internally)
void	sortBy(int column, int Direction) Sort the report by a particular column.
boolean	subscribeToReport(ScheduleRecord schedule)
java.lang.String	toString() Print debug information for current report.
boolean	unsubscribe()

Methods inherited from class java.lang.Object

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

Field Detail

SORT_ASCENDING

public static final int SORT_ASCENDING

Constant value representing ascending sort.

See Also:

Constant Field Values

SORT_DESCENDING

public static final int SORT_DESCENDING

Constant value representing descending sort.

See Also:

Constant Field Values

Constructor Detail

i4Report

public i4Report(ReportServiceResponse rs,
                java.util.HashMap Storage)
         throws WebserviceException

Throws:

WebserviceException

Method Detail

sortBy

public void sortBy(int column,
                   int Direction)
            throws WebserviceException

Sort the report by a particular column. The sort will take effect the next time the report is run.

Parameters:

column -

Direction - either SORT_ASCENDING or SORT_DESCENDING

Throws:

WebserviceException

runCommand

public void runCommand(java.lang.String Command)
                throws WebserviceException

Run a modification command against the report. Pass Command strings generated in the HTML to this function to apply modifications such as sorting, drill down, drill through and page changes.

Parameters:

Command -

Throws:

WebserviceException

getDisplayedReportId

public java.lang.Integer getDisplayedReportId()
                                       throws WebserviceException

After running a report, this will return the id of the report displayed. The displayed report id can be changed by drilling etc

Returns:

The displayed report id or null

Throws:

WebserviceException

run

public void run()
         throws WebserviceException

Run the report. Will populate the report with data returned from webservices.

Throws:

WebserviceException

run

public void run(java.util.HashMap Storage)
         throws WebserviceException

Run the report. Will populate the report with data returned from webservices. Any images will be stored in the Session for retrival from a JSP.

Parameters:

Storage -

Throws:

WebserviceException

run

public void run(java.util.HashMap Storage,
                java.lang.String Type)
         throws WebserviceException

Run the report. Will populate the report with data returned from webservices. Any images will be stored in the Session for retrival from a JSP.

Parameters:

Storage -

Type -

Throws:

WebserviceException

run

public void run(java.util.HashMap Storage,
                java.lang.String Type,
                boolean multiChart)
         throws WebserviceException

Throws:

WebserviceException

populateComments

public boolean populateComments()

postComment

public boolean postComment(java.lang.Integer ParentCommentId,
                           java.lang.String Comment)

postComment

public boolean postComment(java.lang.Integer ParentCommentId,
                           java.lang.String Comment,
                           java.lang.Integer authorId)

populateSubscription

public boolean populateSubscription()

deleteComment

public boolean deleteComment(java.lang.Integer CommentId)

retrieveFilterPromptValues

public java.util.ArrayList retrieveFilterPromptValues(java.lang.Integer filterId)

Retrieves a list of options for a filter. This is used when a filter is set to be displayed as a drop-down list (i.e. a <select> list). This can be determined by checking if the ReportSchema.FilterDisplayType is set to either "DROPDOWN" or "PREDEFDATE".
The returned list contains String Arrays. The first element of each array is the value for the <option> tag, and the second is the display text.

filterHasDependantChildren

public boolean filterHasDependantChildren(java.lang.Integer filterId)

Returns whether or not a filter has child filters that are dependant on it.

populateDetails

public boolean populateDetails()

broadcastReport

public boolean broadcastReport(java.lang.String Subject,
                               java.lang.String content,
                               java.lang.String[] recipients,
                               java.lang.String attachmentType)
                        throws WebserviceException

Throws:

WebserviceException

subscribeToReport

public boolean subscribeToReport(ScheduleRecord schedule)

unsubscribe

public boolean unsubscribe()

distributeReport

public boolean distributeReport(java.lang.String[] recipients)
                         throws WebserviceException

Throws:

WebserviceException

distributeReport

public boolean distributeReport(java.lang.String[] recipients,
                                java.lang.String message)
                         throws WebserviceException

Throws:

WebserviceException

broadcastReport

public boolean broadcastReport(java.lang.String Subject,
                               java.lang.String content,
                               java.lang.String[] recipients,
                               java.lang.String attachmentType,
                               java.lang.String distributeMethod)
                        throws WebserviceException

Throws:

WebserviceException

renderBinary

public byte[] renderBinary()

Render the report. Returns data of ContentType This could be a chunk of PDF or IMAGE data. This function should be used for binary based report types.

Returns:

Report contents

render

public java.lang.String render()

Render the report. Returns data of ContentType This could be a chunk of HTML, XML, CSV. This function should be used for text based report types.

Returns:

Report contents

getReportName

public java.lang.String getReportName()

Get the Report Name

Returns:

Report Name

setReportName

public void setReportName(java.lang.String reportName)

Set the Report Name (Used Internally)

Parameters:

reportName -

getContentType

public java.lang.String getContentType()

Get the Content Type (mime-type) of the report

Returns:

ContentType

getExecutionObject

public java.lang.String getExecutionObject()

Get the Execution Object Name

Returns:

Execution Object Name

getFormatCode

public java.lang.String getFormatCode()

Get the Format Code of Report

Returns:

Report code

getLastRunDuration

public java.lang.Integer getLastRunDuration()

Get last run duration of report

Returns:

Time to run reoirt on server

getLastRunStatus

public java.lang.String getLastRunStatus()

Get last run status

Returns:

Last Run Status

getLastRunTime

public java.math.BigDecimal getLastRunTime()

Get last run time

Returns:

Time that the report was last run

getPort

public int getPort()

Get TCPIP port that is being used for connecting to webservices.

Returns:

Port

getReportId

public java.lang.Integer getReportId()

Get internal Yellowfin report Id

Returns:

Id

getRequestStatus

public java.lang.String getRequestStatus()

Get last webservices request status

Returns:

Status

getUsername

public java.lang.String getUsername()

Get webservices request username

Returns:

Username

getWebServicesURL

public java.lang.String getWebServicesURL()

Get webservices request URL

Returns:

URL

getMessages

public java.lang.String[] getMessages()

Get status messages generated by Yellowfin

Returns:

Messages

getCharts

public java.util.HashMap getCharts()

Get charts returned with the report

Returns:

Charts

getBlobs

public java.util.HashMap getBlobs()

Get binary objects

setCharts

public void setCharts(java.util.HashMap charts)

Set charts

setFilter

public boolean setFilter(java.lang.String ColumnName,
                         java.lang.String DataValue)

Deprecated. use setFilterById(Integer, String)

Set a user prompt filter

Parameters:

ColumnName -

DataValue -

Returns:

true/false if successful

setFilterById

public boolean setFilterById(java.lang.Integer filterId,
                             java.lang.String value)

Set a user prompt filter.

Parameters:

filterId -

value -

Returns:

true/false if successful

setFilterOmittedById

public boolean setFilterOmittedById(java.lang.Integer filterId)

Set a user prompt filter to be omitted.

Parameters:

filterId -

entityValue -

Returns:

true/false if successful

getFilterValue

public java.lang.String getFilterValue(java.lang.String ColumnName,
                                       java.lang.String DataValue)

Deprecated. use getFilterValueById(Integer)

Get the stored value of user prompt filter

Parameters:

ColumnName -

DataValue -

Returns:

true/false if successful

getFilterValueById

public java.lang.String getFilterValueById(java.lang.Integer filterId)

Get the stored value of a user prompt filter.

Parameters:

filterId -

Returns:

the value previously set for the filter

getFilterColumn

public ReportSchema getFilterColumn(java.lang.Integer filterId)

Gets the ReportSchema object for a filter.

Parameters:

filterId -

Returns:

the ReportSchema object for the filter

getFilterColumns

public java.lang.String[] getFilterColumns()

Deprecated. use getFilterIds() or getFilterSchema()

Get the names of all the columns that require user input

Returns:

Filter column names

getFilterIds

public java.lang.Integer[] getFilterIds()

Get the filterIds for all required filters

Returns:

FilterIds

getFilterSchema

public ReportSchema[] getFilterSchema()

Get the column schema objects for all required filters

Returns:

filter columns

getColumnType

public java.lang.String getColumnType(java.lang.String ColumnName)

Get the column type.

Returns:

returns filter time.

getFilterType

public java.lang.String getFilterType(java.lang.String ColumnName)

Deprecated. use getFilterTypeById(Integer)

Get the column type.

Returns:

returns filter time.

getFilterTypeById

public java.lang.String getFilterTypeById(java.lang.Integer filterId)

Get the column type for a filter.

Returns:

the filter type

getColumnDisplayName

public java.lang.String getColumnDisplayName(java.lang.String colName)

Returns the display name for a column.

Parameters:

colName - the column name

Returns:

the display name for the column

toString

public java.lang.String toString()

Print debug information for current report.

Overrides:

toString in class java.lang.Object

Returns:

Detailed report information for debugging

isShowAlertImages

public boolean isShowAlertImages()

Get status of Show Alert Images

Returns:

showAlertImages (boolean on/off)

setShowAlertImages

public void setShowAlertImages(boolean showAlertImages)

Show image based alerts in rendered HTML

Parameters:

showAlertImages - boolean on/off

isShowAlerts

public boolean isShowAlerts()

Get status of Alerts

Returns:

showAlert (boolean on/off)

setShowAlerts

public void setShowAlerts(boolean showAlerts)

Show alerts in rendered report

Parameters:

showAlerts - boolean on/off

isShowCharts

public boolean isShowCharts()

Get status of ShowCharts

Returns:

showCharts (boolean on/off)

setShowCharts

public void setShowCharts(boolean showCharts)

Show charts in rendered report

Parameters:

showCharts - boolean on/off

isShowLinks

public boolean isShowLinks()

Get status of ShowLinks

Returns:

showLinks (boolean on/off)

setShowLinks

public void setShowLinks(boolean showLinks)

Show links in rendered report

Parameters:

showLinks - boolean on/off

isShowTitle

public boolean isShowTitle()

Get status of ShowTitle

Returns:

showTitle (boolean on/off)

setShowTitle

public void setShowTitle(boolean showTitle)

Show title in rendered report

Parameters:

showTitle - boolean on/off

isShowSort

public boolean isShowSort()

Get status of ShowSort

Returns:

showSort (boolean on/off)

setShowSort

public void setShowSort(boolean showSort)

Show sort links in rendered report

Parameters:

showSort - boolean on/off

getVisibleColumns

public int getVisibleColumns()

Get number of visible columns

Returns:

number of columns

setVisibleColumns

public void setVisibleColumns(int visibleColumns)

Set visible column count (used internally)

Parameters:

visibleColumns -

getLinkURL

public java.lang.String getLinkURL()

Returns URL for link generation. Use ## to insert generated content into template, otherwise content is added to the end of the linkURL. Could be "/ModifyReport.do?command=" or "javascript:doCommand('##');"

Returns:

url

setLinkURL

public void setLinkURL(java.lang.String linkURL)

Set URL for link generation. Use ## to insert generated content into template, otherwise content is added to the end of the linkURL. Could be "/ModifyReport.do?command=" or "javascript:doCommand('##');"

Parameters:

linkURL -

getImageURL

public java.lang.String getImageURL()

Returns URL for image generation. Use ## to insert generated content into template, otherwise content is added to the end of the imageURL. Could be "/ModifyReport.do?command=" or "javascript:doCommand('##');"

Returns:

URL

setImageURL

public void setImageURL(java.lang.String imageURL)

Set URL for image generation. Use ## to insert generated content into template, otherwise content is added to the end of the imageURL. Could be "/image.jsp?id=" or "/image.do?id=##&iefix=.png"

Parameters:

imageURL -

getBinaryURL

public java.lang.String getBinaryURL()

Get URL for binary link. Use ## to insert generated content into template, otherwise content is added to the end of the binaryURL. Could be "/image.jsp?id=" or "/image.do?id=##&iefix=.png"

Returns:

URL

setBinaryURL

public void setBinaryURL(java.lang.String binaryURL)

Set URL for binary link. Use ## to insert generated content into template, otherwise content is added to the end of the binaryURL. Could be "/image.jsp?id=" or "/image.do?id=##&iefix=.png"

Parameters:

binaryURL -

getAuthoringMode

public java.lang.String getAuthoringMode()

How the report was authored: "JAVA" (Standard drag-and-drop builder), "SQL" (Freehand SQL), "JASPER", "BIRT".

Returns:

authoring mode

isDashboardEnabled

public boolean isDashboardEnabled()

Is the report enabled for dashboard use?

Returns:

dashboard enabled

getDataOutput

public java.lang.String getDataOutput()

Data output type: "COLUMN", "ROW", "PIVOT"

Returns:

data output

getReportTemplate

public java.lang.String getReportTemplate()

Report template: "REPORT", "CHART", "REPORTANDCHART"

Returns:

report template

getPreReportRunFilter

public java.lang.String getPreReportRunFilter()

setPreReportRunFilter

public void setPreReportRunFilter(java.lang.String preReportRunFilter)

getImageType

public java.lang.String getImageType()

Returns the image type used for rendering charts

setImageType

public void setImageType(java.lang.String imageType)

Setes the image type used for rendering charts ("png", "jpg", "bmp", or "image/png", "image/jpeg", etc)

Parameters:

imageType -

getColumns

public ReportSchema[] getColumns()

Retrieve columns from report object

Returns:

Report Schema array

getReportStyle

public java.lang.String getReportStyle()

Returns the CSS style used for this report. Populated when an HTML call is made.

Returns:

CSS style

isSinglePage

public boolean isSinglePage()

setSinglePage

public void setSinglePage(boolean singlePage)

getReportDescription

public java.lang.String getReportDescription()

getSubCategory

public java.lang.String getSubCategory()

getCategory

public java.lang.String getCategory()

getAuthor

public java.lang.String getAuthor()

getAverageRunTime

public java.lang.Integer getAverageRunTime()

getComments

public ReportComment[] getComments()

setComments

public void setComments(ReportComment[] comments)

setTags

public void setTags(java.lang.String tags)

getTags

public java.lang.String getTags()

setDatasource

public void setDatasource(java.lang.String datasource)

getDatasource

public java.lang.String getDatasource()

setViewName

public void setViewName(java.lang.String viewName)

getViewName

public java.lang.String getViewName()

setLastModifiedDate

public void setLastModifiedDate(java.lang.String lastModifiedDate)

getLastModifiedDate

public java.lang.String getLastModifiedDate()

setBreadcrumbs

public void setBreadcrumbs(BreadCrumb[] breadcrumbs)

getBreadcrumbs

public BreadCrumb[] getBreadcrumbs()

setShowDrillDownStack

public void setShowDrillDownStack(boolean showDrillDownStack)

isShowDrillDownStack

public boolean isShowDrillDownStack()

setShowDrillThroughStack

public void setShowDrillThroughStack(boolean showDrillThroughStack)

isShowDrillThroughStack

public boolean isShowDrillThroughStack()

setSeriesSelection

public void setSeriesSelection(SeriesSelection[] seriesSelection)

getSeriesSelection

public SeriesSelection[] getSeriesSelection()

setShowSeriesSelection

public void setShowSeriesSelection(boolean showSeriesSelection)

isShowSeriesSelection

public boolean isShowSeriesSelection()

getTimeAggregationSelection

public TimeAggregationSelection[] getTimeAggregationSelection()

setTimeAggregationSelection

public void setTimeAggregationSelection(TimeAggregationSelection[] timeAggregationSelection)

getReportTabSelection

public ReportTabSelection[] getReportTabSelection()

setReportTabSelection

public void setReportTabSelection(ReportTabSelection[] reportTabSelection)

isShowTabs

public boolean isShowTabs()

setShowTabs

public void setShowTabs(boolean showTabs)

isShowPageSelection

public boolean isShowPageSelection()

setShowPageSelection

public void setShowPageSelection(boolean showPageSelection)

getReportPageSelection

public ReportPageSelection[] getReportPageSelection()

setReportPageSelection

public void setReportPageSelection(ReportPageSelection[] reportPageSelection)

setSubscriptionSchedule

public void setSubscriptionSchedule(ScheduleRecord subscriptionSchedule)

getSubscriptionSchedule

public ScheduleRecord getSubscriptionSchedule()

isShowTimeSlider

public boolean isShowTimeSlider()

setShowTimeSlider

public void setShowTimeSlider(boolean showTimeSlider)

isShowTimeUnitSelection

public boolean isShowTimeUnitSelection()

setShowTimeUnitSelection

public void setShowTimeUnitSelection(boolean showTimeUnitSelection)

getTimeSliderSelection

public TimeSliderSelection[] getTimeSliderSelection()

setTimeSliderSelection

public void setTimeSliderSelection(TimeSliderSelection[] timeSliderSelection)

getSelectedSortColumn

public java.lang.Integer getSelectedSortColumn()

setSelectedSortColumn

public void setSelectedSortColumn(java.lang.Integer selectedSortColumn)

getSelectedSortType

public java.lang.Integer getSelectedSortType()

setSelectedSortType

public void setSelectedSortType(java.lang.Integer selectedSortType)

getRelatedReports

public RelatedReports getRelatedReports()

setRelatedReports

public void setRelatedReports(RelatedReports relatedReports)

isShowCoDisplay

public boolean isShowCoDisplay()

setShowCoDisplay

public void setShowCoDisplay(boolean showCoDisplay)

getChartWidth

public java.lang.Integer getChartWidth()

setChartWidth

public void setChartWidth(java.lang.Integer chartWidth)

getFitTableWidth

public java.lang.Boolean getFitTableWidth()

setFitTableWidth

public void setFitTableWidth(java.lang.Boolean fitTableWidth)

getChartPlacementCode

public java.lang.String getChartPlacementCode()

setChartPlacementCode

public void setChartPlacementCode(java.lang.String chartPlacementCode)

getAbsoluteTableWidth

public java.lang.Integer getAbsoluteTableWidth()

setAbsoluteTableWidth

public void setAbsoluteTableWidth(java.lang.Integer absoluteTableWidth)

isActiveCharts

public boolean isActiveCharts()

setActiveCharts

public void setActiveCharts(boolean activeCharts)

getSortableColumns

public SortableTableColumn[] getSortableColumns()

setSortableColumns

public void setSortableColumns(SortableTableColumn[] sortableColumns)

isGisNavigation

public boolean isGisNavigation()

setGisNavigation

public void setGisNavigation(boolean gisNavigation)

getDrillCode

public java.lang.String getDrillCode()

setDrillCode

public void setDrillCode(java.lang.String drillCode)

getCanDrill

public java.lang.Boolean getCanDrill()

setCanDrill

public void setCanDrill(java.lang.Boolean canDrill)

getReportUsage

public java.lang.Integer getReportUsage()

setReportUsage

public void setReportUsage(java.lang.Integer reportUsage)

getMultiReportTag

public java.lang.String getMultiReportTag()

setMultiReportTag

public void setMultiReportTag(java.lang.String multiReportTag)

getGisMap

public GISMap[] getGisMap()

setGisMap

public void setGisMap(GISMap[] gisMap)

getChartHeight

public java.lang.Integer getChartHeight()

setChartHeight

public void setChartHeight(java.lang.Integer chartHeight)

getChartScale

public java.lang.Integer getChartScale()

setChartScale

public void setChartScale(java.lang.Integer chartScale)

getGoogleMaps

public GMap[] getGoogleMaps()

setGoogleMaps

public void setGoogleMaps(GMap[] googleMaps)

getLinkFormatterClass

public java.lang.String getLinkFormatterClass()

Returns:

Class type used to generate drill-anywhere links. See ReportDatasetProducer.LinkFormatter.

setLinkFormatterClass

public void setLinkFormatterClass(java.lang.String linkFormatterClass)

Class type used to generate drill-anywhere links. See ReportDatasetProducer.DrillAnywhereLinkGenerator.

Parameters:

drillAnywherLinkGeneratorClass - - Full class name, including namespace.

getLanguageCode

public java.lang.String getLanguageCode()

Returns:

the languageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

Parameters:

languageCode - the languageCode to set

isPrivate

public java.lang.Boolean isPrivate()

Returns:

is the report private

setIsPrivate

public void setIsPrivate(java.lang.Boolean isPrivate)

Parameters:

languageCode - the languageCode to set

getDataFormatterType

public java.lang.String getDataFormatterType()

Data formatter type to use.

Returns:

String object, or null if using default

setDataFormatterType

public void setDataFormatterType(java.lang.String dataFormatterType)

Data formatter type to use

Parameters:

dataFormatterType - String object, or null to use default

canUserSubscribe

public boolean canUserSubscribe()

setCanUserSubscribe

public void setCanUserSubscribe(boolean canUserSubscribe)

isMultiCharts

public boolean isMultiCharts()

setMultiCharts

public void setMultiCharts(boolean multiCharts)

isShowAlertLegendTable

public boolean isShowAlertLegendTable()

setShowAlertLegendTable

public void setShowAlertLegendTable(boolean showAlertLegendTable)

getReportOptions

public java.lang.String[] getReportOptions()

setReportOptions

public void setReportOptions(java.lang.String[] reportOptions)

isAllowInteractiveGoogleMaps

public boolean isAllowInteractiveGoogleMaps()

setAllowInteractiveGoogleMaps

public void setAllowInteractiveGoogleMaps(boolean allowInteractiveGoogleMaps)

isTriggerJSGoogleMapsSetup

public boolean isTriggerJSGoogleMapsSetup()

setTriggerJSGoogleMapsSetup

public void setTriggerJSGoogleMapsSetup(boolean triggerJSGoogleMapsSetup)