Package africa.absa.inception.error

Interface IErrorService

All Known Implementing Classes:

ErrorService

public interface IErrorService

The IErrorService interface defines the functionality provided by an Error Service implementation.

Author:

Marcus Portmann

Method Summary

Modifier and Type	Method	Description
void	createErrorReport(ErrorReport errorReport)	Create the new entry for the error report in the database.
ErrorReport	getErrorReport(UUID errorReportId)	Retrieve the error report.
ErrorReportSummaries	getErrorReportSummaries(String filter, ErrorReportSortBy sortBy, SortDirection sortDirection, Integer pageIndex, Integer pageSize)	Retrieve the error report summaries.
ErrorReportSummary	getErrorReportSummary(UUID errorReportId)	Retrieve the summary for the error report.
List<ErrorReportSummary>	getMostRecentErrorReportSummaries(int maximumNumberOfEntries)	Retrieve the summaries for the most recent error reports.

Method Details

createErrorReport

void createErrorReport(ErrorReport errorReport)
                throws InvalidArgumentException,
ServiceUnavailableException

Create the new entry for the error report in the database.

Parameters:

errorReport - the ErrorReport instance containing the information for the error report

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the error report could not be created

getErrorReport

ErrorReport getErrorReport(UUID errorReportId)
                    throws InvalidArgumentException,
ErrorReportNotFoundException,
ServiceUnavailableException

Retrieve the error report.

Parameters:

errorReportId - the ID for the error report

Returns:

the error report

Throws:

InvalidArgumentException - if an argument is invalid

ErrorReportNotFoundException - if the error report could not be found

ServiceUnavailableException - if the error report could not be retrieved

getErrorReportSummaries

ErrorReportSummaries getErrorReportSummaries(String filter,
 ErrorReportSortBy sortBy,
 SortDirection sortDirection,
 Integer pageIndex,
 Integer pageSize)
                                      throws InvalidArgumentException,
ServiceUnavailableException

Retrieve the error report summaries.

Parameters:

filter - the optional filter to apply to the error reports

sortBy - the optional method used to sort the error reports e.g. by who submitted them

sortDirection - the optional sort direction to apply to the error reports

pageIndex - the optional page index

pageSize - the optional page size

Returns:

the error report summaries

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the error report summaries could not be retrieved

getErrorReportSummary

ErrorReportSummary getErrorReportSummary(UUID errorReportId)
                                  throws InvalidArgumentException,
ErrorReportNotFoundException,
ServiceUnavailableException

Retrieve the summary for the error report.

Parameters:

errorReportId - the ID for the error report

Returns:

the summary for the error report

Throws:

InvalidArgumentException - if an argument is invalid

ErrorReportNotFoundException - if the error report could not be found

ServiceUnavailableException - if the error report summary could not be retrieved

getMostRecentErrorReportSummaries

List<ErrorReportSummary> getMostRecentErrorReportSummaries(int maximumNumberOfEntries)
                                                    throws InvalidArgumentException,
ServiceUnavailableException

Retrieve the summaries for the most recent error reports.

Parameters:

maximumNumberOfEntries - the maximum number of summaries for the most recent error reports to retrieve

Returns:

the summaries for the most recent error reports

Throws:

InvalidArgumentException - if an argument is invalid

ServiceUnavailableException - if the most recent error report summaries could not be retrieved