org.kuali.kra.award.paymentreports.awardreports.reporting.service

Interface ReportTrackingService

All Known Implementing Classes:

ReportTrackingServiceImpl

public interface ReportTrackingService

This class manages the services needed for Report Tracking.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	autoRegenerateReports(Award award) This method returns true if the award is a root award, otherwise returns false.
void	generateReportTrackingAndSave(Award award, boolean forceReportRegeneration) This method generates the reports for all the award report items in the award.
List<ReportTracking>	getReportTacking(Award award) This method returns all the report tracking records asociated with an award.
List<ReportTracking>	getReportTacking(AwardReportTerm awardTerm) This method gets all the saved ReportTracking objects for a given AwardReportTerm.
void	refreshReportTracking(Award award) This method simply refreshes the reporting tracking objects, no delete, no save.
void	setReportTrackingListSelected(List<ReportTracking> reportTrackingListing, boolean selectedValue) This method updates the MultiEditSelected attributes of every ReportTracking object in the list to whatever the selectedValue value is.
boolean	shouldAlertReportTrackingDetailChange(Award award) This method compares the passed in award to the DB version of the award and checks to see if any fields have changed that will cause changes to the report tracking records.
void	updateMultipleReportTrackingRecords(List<ReportTracking> reportTrackingListing, ReportTrackingBean reportTrackingBean) This method updates the value of every object in the reportTrackingListing list that has a true value for MultiEditSelected for each attribture that is populated in the report tracking bean.

Method Detail

generateReportTrackingAndSave

void generateReportTrackingAndSave(Award award,
                                 boolean forceReportRegeneration)
                                   throws ParseException

This method generates the reports for all the award report items in the award. Use the forceReportRegeneration to over ride the autoRegenerateReports call.

Parameters:

award -

forceReportRegeneration -

Throws:

ParseException

refreshReportTracking

void refreshReportTracking(Award award)
                           throws ParseException

This method simply refreshes the reporting tracking objects, no delete, no save.

Parameters:

award -

Throws:

ParseException

getReportTacking

List<ReportTracking> getReportTacking(AwardReportTerm awardTerm)

This method gets all the saved ReportTracking objects for a given AwardReportTerm.

Parameters:

awardTerm -

Returns:

getReportTacking

List<ReportTracking> getReportTacking(Award award)

This method returns all the report tracking records asociated with an award.

Parameters:

award -

Returns:

autoRegenerateReports

boolean autoRegenerateReports(Award award)

This method returns true if the award is a root award, otherwise returns false.

Parameters:

award -

Returns:

setReportTrackingListSelected

void setReportTrackingListSelected(List<ReportTracking> reportTrackingListing,
                                 boolean selectedValue)

This method updates the MultiEditSelected attributes of every ReportTracking object in the list to whatever the selectedValue value is.

Parameters:

reportTrackingListing -

selectedValue -

updateMultipleReportTrackingRecords

void updateMultipleReportTrackingRecords(List<ReportTracking> reportTrackingListing,
                                       ReportTrackingBean reportTrackingBean)

This method updates the value of every object in the reportTrackingListing list that has a true value for MultiEditSelected for each attribture that is populated in the report tracking bean.

Parameters:

reportTrackingListing -

reportTrackingBean -

shouldAlertReportTrackingDetailChange

boolean shouldAlertReportTrackingDetailChange(Award award)

This method compares the passed in award to the DB version of the award and checks to see if any fields have changed that will cause changes to the report tracking records. If this message returns true, the caller of this function should display a warning message to the user about this change.

Parameters:

award -

Returns: