| commit | author | age | ||
| 66d68b | 1 | /* |
| U | 2 | Zeitrechnung - a class library to determine calendar events |
| 3 | Copyright (c) 1984-2022 Ulrich Hilger, http://uhilger.de | |
| 4 | ||
| 5 | This program is free software: you can redistribute it and/or modify | |
| 6 | it under the terms of the GNU Affero General Public License as published by | |
| 7 | the Free Software Foundation, either version 3 of the License, or | |
| 8 | (at your option) any later version. | |
| 9 | ||
| 10 | This program is distributed in the hope that it will be useful, | |
| 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 | GNU Affero General Public License for more details. | |
| 14 | ||
| 15 | You should have received a copy of the GNU Affero General Public License | |
| 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 17 | */ | |
| 18 | package de.uhilger.zeitrechnung.ereignis; | |
| 19 | ||
| 20 | import de.uhilger.zeitrechnung.Datum; | |
| 21 | import de.uhilger.zeitrechnung.Definition; | |
| 22 | import java.util.List; | |
| 23 | ||
| 24 | /** | |
| 25 | * Die Schnittstelle Ereignis modelliert Kalenderereignisse in Form von | |
| 26 | * Ereignis-Typen und bis zu vier Ganzzahl-Parametern, die je nach | |
| 27 | * Ereignis-Typ den Zeitpunkt beschreiben, an dem ein Ereignis stattfindet. | |
| 28 | * | |
| 29 | * Die Bedeutung und Verwendung der Parameter ist fuer jeden Ereignis-Typ | |
| 30 | * in der Klassenbeschreibung des jeweiligen Ereignis-Typs enthalten. | |
| 31 | * | |
| 32 | * @author Ulrich Hilger | |
| 33 | */ | |
| 34 | public interface Ereignis { | |
| 35 | ||
| 36 | /* Typnummer fuer DatumEreignis */ | |
| 37 | public static final int TYP_DATUM = 1; | |
| 38 | ||
| 39 | /* Typnummer TagWocheMonatEreignis */ | |
| 40 | public static final int TYP_TAG_WOCHE_MONAT = 2; | |
| 41 | ||
| 42 | /** Typnummer fuer TagDatumEreignis */ | |
| 43 | public static final int TYP_TAG_DATUM = 3; | |
| 44 | ||
| 45 | /** Typnummer fuer OsterEreignis */ | |
| 46 | public static final int TYP_OSTERN = 4; | |
| 47 | ||
| 48 | /** Typnummer fuer JahreszeitEreignis */ | |
| 49 | public static final int TYP_JAHRESZEIT = 5; | |
| 50 | ||
| 51 | /** Typnummer fuer HebraeischesEreignis */ | |
| 52 | public static final int TYP_HEBRAEISCH = 6; | |
| 53 | ||
| 54 | /** Typnummer fuer EinzelEreignis */ | |
| 55 | public static final int TYP_EINZEL = 7; | |
| 56 | ||
| 57 | /** Typnummer fuer MuslimischesEreignis */ | |
| 58 | public static final int TYP_MUSLIMISCH = 8; | |
| 59 | ||
| 60 | /** | |
| 61 | * Den Typ des Ereignisses ermitteln | |
| 62 | * | |
| 63 | * @return Ereignis.TYP_DATUM oder Ereignis.TYP_OSTERN oder | |
| 64 | * Ereignis.TYP_WOCHENTAG_DATUM usw. | |
| 65 | */ | |
| 66 | public int getTyp(); | |
| 67 | ||
| 68 | /** | |
| 69 | * Die Definition des Ereignisses ermitteln | |
| 70 | * @return das Definitionsobjekt fuer dieses Ereignis | |
| 71 | */ | |
| 72 | public Definition getDefinition(); | |
| 73 | ||
| 74 | /** | |
| 75 | * Die Definition dieses Ereignisses angeben | |
| 76 | * @param definition das Definitionsobjekt dieses Ereignisses | |
| 77 | */ | |
| 78 | public void setDefinition(Definition definition); | |
| 79 | ||
| 80 | /** | |
| 81 | * Die Tage eines Jahres im gregorianischen Kalendersystem | |
| 82 | * ermitteln, an denen das Ereignis stattfindet. | |
| 83 | * | |
| 84 | * @param isoJahr das Jahr im gregorianischen Kalender, | |
| 85 | * fuer das ermittelt werden soll, an welchen Tagen das Ereignis stattfindet | |
| 86 | * @return die Liste aus Datum-Objekten, die die Tage im gregorianischen | |
| 87 | * Kalender bezeichnet, an denen das Ereignis stattfindet | |
| 88 | */ | |
| 89 | public List<Datum> getZeitpunkte(long isoJahr); | |
| 90 | } | |
