com.ebay.carad.os.vitalsigns
Interface IDashboardReport

All Superinterfaces:

java.lang.Comparable, IReportingListenerContainer

All Known Implementing Classes:

DashboardReport

public interface IDashboardReport
extends java.lang.Comparable, IReportingListenerContainer

Configuration object for the reports that are run by ReportAgent.

Version:

$Id$

Author:

Jeremy Kraybill, Jeremy Thomerson

Method Summary

int	getFrequencyInMinutes() Gets the frequency in minutes for the logging and generation of this report.
int	getID() Returns the ID of this report, used to key off the report's datasource.
boolean	getIncludeInSummary()
boolean	getMoreIsBetter() Returns whether this report represents a value that should be increasing over time.
java.lang.Float	getPreviousData()
int	getSortOrder() Returns the display sort order of this report.
java.lang.String	getSubTitle() Returns the sub-title of this report, which will appear under the report's main title.
java.lang.Float	getThisRunData()
java.lang.String	getTitle() Returns the title of this report.
void	run(IDashboardAgent agent, long reportTime) Causes this report to run; based on this report's configuration, may cause logging and/or report generation to occur.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.ebay.carad.os.vitalsigns.IReportingListenerContainer

addReportingListener, getReportingListeners

Method Detail

run

void run(IDashboardAgent agent,
         long reportTime)
         throws ReportingException

Causes this report to run; based on this report's configuration, may cause logging and/or report generation to occur.

Parameters:

reportTime - the time this report run was kicked off (in ms since epoch)

Throws:

ReportingException - if bad things happen during the run

getThisRunData

java.lang.Float getThisRunData()

Returns:

The data from the most recent run.

getPreviousData

java.lang.Float getPreviousData()

Returns:

the data from the run prior to the most recent run

getID

int getID()

Returns the ID of this report, used to key off the report's datasource.

Returns:

the ID of the report

getTitle

java.lang.String getTitle()

Returns the title of this report.

Returns:

the title of this report

getSubTitle

java.lang.String getSubTitle()

Returns the sub-title of this report, which will appear under the report's main title.

Returns:

the sub-title

getSortOrder

int getSortOrder()

Returns the display sort order of this report.

Returns:

the sortorder for display purposes

getMoreIsBetter

boolean getMoreIsBetter()

Returns whether this report represents a value that should be increasing over time.

Returns:

if true, this report is "happy" when its value has increased

getFrequencyInMinutes

int getFrequencyInMinutes()

Gets the frequency in minutes for the logging and generation of this report.

Returns:

the frequency in minutes

getIncludeInSummary

boolean getIncludeInSummary()

Returns:

whether this report should be included in any summaries generated regarding reports