GetLessons (Opus Funktion)

Owned by Michael Spühler
Last updated: 26.10.2023 by Eva Spühler
2 min read

Beschreibung

Gibt eine Liste mit Lektionen gemäss bestimmten Kriterien zurück.

Argumente

Name
Typ
Beschreibung
FirstDatedatetimeErstes Datum
LastDatedatetimeLetztes Datum
StartTimeintegerStartzeit (z.B. 945 für 9h45)
EndTimeintegerEndzeit (z.B. 1350 für 13h50)
Roominteger

> 0 bedeutet, dass nur Lektionen mit dieser Raum-ID zurückgegeben werden

= 0 bedeutet, dass keine Einschränkung auf Räume geschieht

= -1 bedeutet, dass nur Lektionen ohne Raum zurückgegeben werden

= -2 bedeutet, dass Nur Lektionen mit Raumzuteilung zurückgegeben werden

= -3 bedeutet, dass nur Lektionen ohne Raum oder mit Ressourcenkonflikten (gemäss dem Argument CheckResources) zurückgegeben werden

= -4 bedeutet, dass nur Lektionen mit Ressourcenkonflikten (gemäss dem Argument CheckResources) zurückgegeben werden

EventTypeinteger

= 0 bedeutet, dass alle Lektionen ohne Einschränkung zurückgegeben werden sollen

= 1 bedeutet, dass Klassenlektionen zurückgegeben werden sollen

= 2 bedeutet, dass Einzellektionen zurückgegeben werden sollen

= 3 bedeutet, dass Anlässe zurückgegeben werden sollen

= 10 bedeutet, dass Prüfungstermine zurückgegeben werden sollen

andere Werte bewirken, dass alles ausser Klassenlektionen und Anlässe zurückgegeben werden soll

NoPublicHolidaysinteger= 1 bedeutet, dass Feiertage ausgenommen werden
PlanningPeriodIDinteger

> 0 bedeutet ID der Planungsperiode

= 0 bedeutet, dass die in der Software ausgewählte Planungsperiode genommen werden soll

= -1 bedeutet, dass alle Planungsperioden berücksichtigt werden sollen. In diesem Fall wird das Argument CheckResources ignoriert und keine Ressourcenprüfung gemacht.

CheckResourcesinteger

Ressourcenprüfung:

= 0 bedeutet keine Ressourcenprüfung, sonst geben folgende Binärwerte an, was geprüft werden soll

1: Prüfen, ob Raum frei ist.

2: Prüfen, ob der Raum genügend gross ist.

Wenn PlanningPeriod = -1 übergeben wird, dann wird keine Ressourcenprüfung gemacht

Rückgabewert Objekt

Es wird ein Objekt mit folgenden Arrays zurückgegeben. Alle Arrays sind gleich gross.

Name
Typ
Beschreibung
 LessonID[integer]ID der Lektion  (nur IDs von aktiven Klassen)
StartDateTime [datetime]Datum und Zeit des Lektionenstarts (brutto, inkl. allfälliger Pufferzeit), limitiert auf die angegebene Startzeit
EndDateTime [datetime]Datum und Zeit des Lektionenendes (brutto, inkl. allfälliger Pufferzeit), limitiert auf die angegebene Endzeit
StartMinutes [integer]Effektiver Start der Lektion am Tag in Minuten (brutto)
EndMinutes[integer]Effektives Ende der Lektion am Tag in Minuten (brutto)
Duration [integer]Dauer der Lektion in Minuten
WeekDate[datetime]

Datum des Montags der Woche in welcher die Lektion stattfindet

ClassCombinations [integer]Anzahl der kombinierten Klassengruppen
AdditionalRooms [integer]

Anzahl der zusätzlichen Räume

DateID [integer]

ID des Wochentermins

RoomID[integer]ID des zugeordneten Raumes
EventType[integer]

= 0 Anlass

= 1 Klassenlektion

= 2 Einzellektion

= 10 Prüfungstermin

ResourceCheck[integer]

Dieses Feld wird nur zurückgegeben, wenn das Argument CheckResources != 0 ist und effektiv eine Ressourcenprüfung gemacht wurde.

= 0 bedeutet, dass keine Ressourcenkonflikte bestehen. Sonst ist es eine binäre Kombination aus folgenden Werten:

1: Einer der Räume ist schon besetzt

2: Der Hauptraum ist zu klein

Beispiel

Lo_LessonsNoRoom = GetLessons(Filter.DateFrom,Filter.DateTo,0,2355,-1,0,0,0,3);

Siehe auch

---