org.kuali.kfs.sys.service
Interface ReportWriterService

All Known Subinterfaces:

DocumentNumberAwareReportWriterService, FiscalYearAwareReportWriterService

All Known Implementing Classes:

BalanceSummaryReportWriterTextServiceImpl, PreScrubberReportWriterTextServiceImpl, ReportWriterTextServiceImpl, ScrubberListingReportWriterTextServiceImpl

public interface ReportWriterService

Service interface defines methods that are relevant to writing a report

Method Summary

void	pageBreak() Breaking the page and write a new header
void	writeError(org.kuali.rice.kns.bo.BusinessObject businessObject, List<Message> messages) Same as writeError except that it provides for multiple messages for the BO.
void	writeError(org.kuali.rice.kns.bo.BusinessObject businessObject, Message message) Writes an error message for the passed in business object.
void	writeFormattedMessageLine(String format) Pass through to PrintStream.printf except that it also handles pagination.
void	writeFormattedMessageLine(String format, Object... args) Pass through to PrintStream.printf except that it also handles pagination.
void	writeMultipleFormattedMessageLines(String format, Object... args)
void	writeNewLines(int lines) Writes "lines" number of newlines to the report
void	writeParameterLine(String message, Object... args) Writes parameter usually placed at the end of the report.
void	writeStatisticLine(String message, Object... args) Writes statistics usually placed at the end of the report.
void	writeSubTitle(String message) Writes a centered message.
void	writeTable(List<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjects, boolean isHeaderRepeatedInNewPage, boolean isRowBreakAcrossPageAllowed) Write table into a report for the given list of business objects
void	writeTableHeader(org.kuali.rice.kns.bo.BusinessObject businessObject) Write table header into a report for the given business object
void	writeTableHeader(Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass) Write table header into a report for business objects of the given class
void	writeTableRow(org.kuali.rice.kns.bo.BusinessObject businessObject) Write table row into a report for the given business object
void	writeTableRowSeparationLine(org.kuali.rice.kns.bo.BusinessObject businessObject) write a separation line in a table
void	writeTableRowWithColspan(org.kuali.rice.kns.bo.BusinessObject businessObject) Write table row into a report for the given business object and also take the colspan in account

Method Detail

writeSubTitle

void writeSubTitle(String message)

Writes a centered message. The purpose of this is primarily to write custom subtitles necessary in some reports

Parameters:

message - to be written centered

writeError

void writeError(org.kuali.rice.kns.bo.BusinessObject businessObject,
                Message message)

Writes an error message for the passed in business object. If the business object is the first or different then the previous one a table header is printed per definition in the implementation of this service

Parameters:

businessObject - controlling the table header and values to be printed

message - associated with the businessObject

writeError

void writeError(org.kuali.rice.kns.bo.BusinessObject businessObject,
                List<Message> messages)

Same as writeError except that it provides for multiple messages for the BO. BO values are only printed once and then messages each row below that.

Parameters:

businessObject - controlling the table header and values to be printed

messages - associated with the businessObject

writeStatisticLine

void writeStatisticLine(String message,
                        Object... args)

Writes statistics usually placed at the end of the report. If this is the first time this method is called then a statistics header is written. All messages are indented per STATISTICS_LEFT_PADDING. If multiple lines are needed, call this method multiple times to assure pagination works properly

Parameters:

message - to write

args - for the message per standard String.format

writeParameterLine

void writeParameterLine(String message,
                        Object... args)

Writes parameter usually placed at the end of the report. If this is the first time this method is called then a parameter header is written. All messages are indented per PARAMETERS_LEFT_PADDING. If multiple lines are needed, call this method multiple times to assure pagination works properly

Parameters:

message - to write

args - for the message per standard String.format

writeNewLines

void writeNewLines(int lines)

Writes "lines" number of newlines to the report

Parameters:

lines - number of newlines to write to the report

writeFormattedMessageLine

void writeFormattedMessageLine(String format)

Pass through to PrintStream.printf except that it also handles pagination. If multiple lines are needed, call this method multiple times to assure pagination works properly

Parameters:

format -

writeFormattedMessageLine

void writeFormattedMessageLine(String format,
                               Object... args)

Pass through to PrintStream.printf except that it also handles pagination. If multiple lines are needed, call this method multiple times to assure pagination works properly

Parameters:

format -

args -

writeMultipleFormattedMessageLines

void writeMultipleFormattedMessageLines(String format,
                                        Object... args)

writeTableHeader

void writeTableHeader(org.kuali.rice.kns.bo.BusinessObject businessObject)

Write table header into a report for the given business object

Parameters:

businessObject - the given business object

writeTableHeader

void writeTableHeader(Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass)

Write table header into a report for business objects of the given class

Parameters:

businessObjectClass - the given class of a business object

writeTableRow

void writeTableRow(org.kuali.rice.kns.bo.BusinessObject businessObject)

Write table row into a report for the given business object

Parameters:

businessObject - the given business object

writeTable

void writeTable(List<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjects,
                boolean isHeaderRepeatedInNewPage,
                boolean isRowBreakAcrossPageAllowed)

Write table into a report for the given list of business objects

Parameters:

businessObjects - the given business objects

isHeaderRepeatedInNewPage - instruct if the header row needs to be repeated in a new page

isRowBreakAcrossPageAllowed - determine whether a row can be broken across pages

pageBreak

void pageBreak()

Breaking the page and write a new header

writeTableRowWithColspan

void writeTableRowWithColspan(org.kuali.rice.kns.bo.BusinessObject businessObject)

Write table row into a report for the given business object and also take the colspan in account

Parameters:

businessObject - the given business object

writeTableRowSeparationLine

void writeTableRowSeparationLine(org.kuali.rice.kns.bo.BusinessObject businessObject)

write a separation line in a table

Parameters:

businessObject - the given business object