Package ch.tocco.nice2.reporting.api.description

Interface ReportDescriptionLoader

All Known Implementing Classes:

EntityReportDescriptionLoader, ResourceReportDescriptionLoader

public interface ReportDescriptionLoader

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReportDescriptionLoader.ReportDescriptionNotFoundException

Method Summary

Modifier and Type	Method	Description
Set<? extends ReportDescription>	getAllReportDescriptions()	Get all ReportDescriptions the loader can access.
default ReportDescription	getReportDescription(String id)	Get a ReportDescription object for the provided id
ReportDescription	getReportDescription(String id, @Nullable PrimaryKey labelKey)	Get a ReportDescription object for the provided id

Method Details

getReportDescription

ReportDescription getReportDescription(String id,
 @Nullable
 @Nullable PrimaryKey labelKey)
                                throws ReportDescriptionLoader.ReportDescriptionNotFoundException

Get a ReportDescription object for the provided id

Parameters:

id - a report id

Returns:

the corresponding ReportDescription object

Throws:

ReportDescriptionLoader.ReportDescriptionNotFoundException

getReportDescription

default ReportDescription getReportDescription(String id)
                                        throws ReportDescriptionLoader.ReportDescriptionNotFoundException

Get a ReportDescription object for the provided id

Parameters:

id - a report id

Returns:

the corresponding ReportDescription object

Throws:

ReportDescriptionLoader.ReportDescriptionNotFoundException

getAllReportDescriptions

Set<? extends ReportDescription> getAllReportDescriptions()

Get all ReportDescriptions the loader can access.

Returns:

a set of ReportDescription