org.opennms.reporting.availability
Interface AvailabilityCalculator

All Known Implementing Classes:

AvailabilityCalculatorImpl

public interface AvailabilityCalculator

AvailabilityCalculator interface.

Method Summary

void	calculate() calculate
String	getAuthor() getAuthor
String	getBaseDir() getBaseDir
String	getCategoryName() getCategoryName
String	getLogoURL() getLogoURL
String	getMonthFormat() getMonthFormat
String	getOutputFileName() getOutputFileName
Date	getPeriodEndDate() getPeriodEndDate
Report	getReport() getReport
String	getReportFormat() getReportFormat
void	marshal(File outputFile) marshal
void	setAuthor(String author) setAuthor
void	setAvailabilityData(AvailabilityData availabilityData) setAvailabilityData
void	setBaseDir(String baseDir) setBaseDir
void	setCalendar(Calendar calendar) setCalendar
void	setCategoryName(String categoryName) setCategoryName
void	setLogoURL(String logoURL) setLogoURL
void	setMonthFormat(String monthFormat) setMonthFormat
void	setOutputFileName(String outputFileName) setOutputFileName
void	setPeriodEndDate(Date periodEndDate) setPeriodEndDate
void	setReportFormat(String reportFormat) setReportFormat
void	setReportStoreService(ReportStoreService reportStoreService) setReportStoreService
String	writeLocateableXML(String id) writeLocateableXML
String	writeXML() writeXML
void	writeXML(OutputStream outputStream) writeXML
void	writeXML(String outputFileName) writeXML

Method Detail

calculate

void calculate()
               throws AvailabilityCalculationException

calculate

Throws:

AvailabilityCalculationException - if any.

writeXML

String writeXML()
                throws AvailabilityCalculationException

writeXML

Returns:

a String object.

Throws:

AvailabilityCalculationException - if any.

writeXML

void writeXML(String outputFileName)
              throws AvailabilityCalculationException

writeXML

Parameters:

outputFileName - a String object.

Throws:

AvailabilityCalculationException - if any.

writeXML

void writeXML(OutputStream outputStream)
              throws AvailabilityCalculationException

writeXML

Parameters:

outputStream - a OutputStream object.

Throws:

AvailabilityCalculationException - if any.

writeLocateableXML

String writeLocateableXML(String id)
                          throws AvailabilityCalculationException

writeLocateableXML

Parameters:

id - a String object.

Returns:

a String object.

Throws:

AvailabilityCalculationException - if any.

marshal

void marshal(File outputFile)
             throws AvailabilityCalculationException

marshal

Parameters:

outputFile - a File object.

Throws:

AvailabilityCalculationException - if any.

getLogoURL

String getLogoURL()

getLogoURL

Returns:

a String object.

setLogoURL

void setLogoURL(String logoURL)

setLogoURL

Parameters:

logoURL - a String object.

getOutputFileName

String getOutputFileName()

getOutputFileName

Returns:

a String object.

setOutputFileName

void setOutputFileName(String outputFileName)

setOutputFileName

Parameters:

outputFileName - a String object.

getAuthor

String getAuthor()

getAuthor

Returns:

a String object.

setAuthor

void setAuthor(String author)

setAuthor

Parameters:

author - a String object.

getCategoryName

String getCategoryName()

getCategoryName

Returns:

a String object.

setCategoryName

void setCategoryName(String categoryName)

setCategoryName

Parameters:

categoryName - a String object.

getMonthFormat

String getMonthFormat()

getMonthFormat

Returns:

a String object.

setMonthFormat

void setMonthFormat(String monthFormat)

setMonthFormat

Parameters:

monthFormat - a String object.

getReportFormat

String getReportFormat()

getReportFormat

Returns:

a String object.

setReportFormat

void setReportFormat(String reportFormat)

setReportFormat

Parameters:

reportFormat - a String object.

getReport

Report getReport()

getReport

Returns:

a Report object.

setCalendar

void setCalendar(Calendar calendar)

setCalendar

Parameters:

calendar - a Calendar object.

getPeriodEndDate

Date getPeriodEndDate()

getPeriodEndDate

Returns:

a Date object.

setPeriodEndDate

void setPeriodEndDate(Date periodEndDate)

setPeriodEndDate

Parameters:

periodEndDate - a Date object.

setReportStoreService

void setReportStoreService(ReportStoreService reportStoreService)

setReportStoreService

Parameters:

reportStoreService - a ReportStoreService object.

getBaseDir

String getBaseDir()

getBaseDir

Returns:

a String object.

setBaseDir

void setBaseDir(String baseDir)

setBaseDir

Parameters:

baseDir - a String object.

setAvailabilityData

void setAvailabilityData(AvailabilityData availabilityData)

setAvailabilityData

Parameters:

availabilityData - a AvailabilityData object.