org.eclipse.emfforms.spi.common.report

Interface ReportService

All Known Implementing Classes:

ReportServiceImpl

public interface ReportService

Service for reporting and aggregating errors.

Since:

1.5

Author:

emueller

Method Summary

Modifier and Type	Method and Description
void	addConsumer(ReportServiceConsumer consumer) Adds a ReportServiceConsumer that consumes ReportEntities.
void	clearReports() Deprecated. Calling this method doesn't have any effect. It will also be removed with the next release.
List<AbstractReport>	getReports() Deprecated. If you want to track all reports use addConsumer(ReportServiceConsumer), in order to add an report use report(AbstractReport). This method will be removed with the next release.
void	removeConsumer(ReportServiceConsumer consumer) Removes a ReportServiceConsumer.
void	report(AbstractReport reportEntity) Report an AbstractReport to the service.

Method Detail

report

void report(AbstractReport reportEntity)

Report an AbstractReport to the service.

Parameters:

reportEntity - the report entity

getReports

@Deprecated
List<AbstractReport> getReports()

Deprecated. If you want to track all reports use addConsumer(ReportServiceConsumer), in order to add an report use report(AbstractReport). This method will be removed with the next release.

Returns all ReportEntities.

Returns:

all ReportEntries

clearReports

@Deprecated
void clearReports()

Deprecated. Calling this method doesn't have any effect. It will also be removed with the next release.

Discards all ReportEntities.

addConsumer

void addConsumer(ReportServiceConsumer consumer)

Adds a ReportServiceConsumer that consumes ReportEntities.

Parameters:

consumer - a ReportServiceConsumer

removeConsumer

void removeConsumer(ReportServiceConsumer consumer)

Removes a ReportServiceConsumer.

Parameters:

consumer - the consumer to be removed