de.svws_nrw.davapi.data.IKalenderEintragRepository Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of svws-module-dav-api Show documentation

Diese Bibliothek enthält die Java-Server-Definition der CalDAV und CardDAV-Schnittstelle für die Schulverwaltungssoftware in NRW

The newest version!

package de.svws_nrw.davapi.data;

import java.util.Optional;

import de.svws_nrw.core.data.kalender.KalenderEintrag;
import de.svws_nrw.davapi.data.repos.dav.DavException;

/**
 * Interface Definition für Repositories von Kalendereinträgen.
 */
public interface IKalenderEintragRepository {

	/**
	 * Ermittelt eine Liste aller Einträge aus einem Kalender mir der angegebenen
	 * Id.
	 *
	 * @param kalenderId         Id des Kalenders
	 * @param kalenderEintragUID Id des Kalendereintrags
	 * @param params             Parameter zum filtern der Datenmenge, die abgefragt
	 *                           wird
	 * @return Optional des Kalendereintrags
	 */
	Optional getKalenderEintragByKalenderAndUID(String kalenderId, String kalenderEintragUID,
			CollectionRessourceQueryParameters params);

	/**
	 * Speichern einen Kalendereintrag. Existiert dieser bereits, erfährt der
	 * Eintrag ein Update, anderfalls wird der Eintrag neu angelegt.
	 *
	 * @param kalenderEintrag Kalendereintrag
	 * @return Gespeicherter Kalendereintrag
	 * @throws DavException bei fehlenden Rechten oder Fehlern beim Schreiben in die
	 *                      Datenbank
	 */
	KalenderEintrag saveKalenderEintrag(KalenderEintrag kalenderEintrag) throws DavException;
}