Package de.svws_nrw.module.reporting.factories

Klasse ReportingFactory

java.lang.Object

de.svws_nrw.module.reporting.factories.ReportingFactory

public final class ReportingFactory
extends Object

Diese Klasse stellt nach dem Aufruf über die API den Einstiegspunkt in die Report-Generierung dar.

Über die Reporting-Parameter werden unter anderem das Report-Format, das zu verwendende Template und die zu druckenden Daten definiert.

Rückgabe ist eine dem Zielformat entsprechende Response oder im Fehlerfall eine SimpleOperationResponse mit Log-Informationen.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ReportingFactory(DBEntityManager conn, ReportingParameter reportingParameter)	Erzeugt eine neue Reporting-Factory, um einen Report zu erzeugen.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
jakarta.ws.rs.core.Response	createReportResponse()	Erstellt eine Response in Form einer einzelnen Datei oder ZIP-Datei mit den mehreren generierten Report-Dateien.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

ReportingFactory

public ReportingFactory(DBEntityManager conn,
 ReportingParameter reportingParameter)
                 throws ApiOperationException

Erzeugt eine neue Reporting-Factory, um einen Report zu erzeugen.

Parameter:

conn - Die Verbindung zur Datenbank.

reportingParameter - Einstellungen und Daten zum Steuern der Report-Generierung.

Löst aus:

ApiOperationException - im Fehlerfall

Methodendetails

createReportResponse

public jakarta.ws.rs.core.Response createReportResponse()
                                                 throws ApiOperationException

Erstellt eine Response in Form einer einzelnen Datei oder ZIP-Datei mit den mehreren generierten Report-Dateien.

Gibt zurück:

Im Falle eines Success enthält die HTTP-Response das Dokument oder die ZIP-Datei.

Löst aus:

ApiOperationException - Im Fehlerfall wird eine ApiOperationException ausgelöst und Log-Daten zusammen mit dieser zurückgegeben.