Package africa.absa.inception.error

Class ErrorService

java.lang.Object

africa.absa.inception.error.ErrorService

All Implemented Interfaces:

IErrorService

@Service
public class ErrorService
extends Object
implements IErrorService

The ErrorService class provides the Error Service implementation.

Author:

Marcus Portmann

Constructor Summary

Constructors

Constructor	Description
ErrorService(org.springframework.context.ApplicationContext applicationContext, javax.validation.Validator validator, ErrorReportRepository errorReportRepository, ErrorReportSummaryRepository errorReportSummaryRepository)	Constructs a new ErrorService.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ErrorService

public ErrorService(org.springframework.context.ApplicationContext applicationContext,
 javax.validation.Validator validator,
 ErrorReportRepository errorReportRepository,
 ErrorReportSummaryRepository errorReportSummaryRepository)

Constructs a new ErrorService.

Parameters:

applicationContext - the Spring application context

validator - the JSR-303 validator

errorReportRepository - the Error Report Repository

errorReportSummaryRepository - the Error Report Summary Repository

Method Details

createErrorReport

@Transactional
public void createErrorReport(ErrorReport errorReport)
                       throws InvalidArgumentException,
ServiceUnavailableException

Description copied from interface: IErrorService

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

Specified by:

createErrorReport in interface IErrorService

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

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

Description copied from interface: IErrorService

Retrieve the error report.

Specified by:

getErrorReport in interface IErrorService

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

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

Description copied from interface: IErrorService

Retrieve the error report summaries.

Specified by:

getErrorReportSummaries in interface IErrorService

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

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

Description copied from interface: IErrorService

Retrieve the summary for the error report.

Specified by:

getErrorReportSummary in interface IErrorService

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

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

Description copied from interface: IErrorService

Retrieve the summaries for the most recent error reports.

Specified by:

getMostRecentErrorReportSummaries in interface IErrorService

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