Added more documentation from FinTS spec

This commit is contained in:
dankito 2024-08-24 17:13:22 +02:00
parent 40b916a49f
commit 87c59e63ee
2 changed files with 26 additions and 0 deletions

View File

@ -14,8 +14,16 @@ open class BankParameters(
val bankName: String,
/**
* Anzahl Geschäftsvorfallsarten:
* Maximale Anzahl an Geschäftsvorfallsarten, die pro Nachricht zulässig ist.
* Der Wert 0 gibt an, dass keine Restriktionen bzgl. der Anzahl an Geschäftsvorfallsarten bestehen.
*
* In einer Nachricht sind Aufträge beliebiger unterschiedlicher Geschäftsvorfallsarten
* zugelassen (z. B. drei Segmente HKCCS und ein Segment HKSAL). Eine Einschränkung ist mit Hilfe des Feldes Anzahl Geschäftsvorfallsarten im Segment
* Bankparameter allgemein möglich.
*
* Maximale Anzahl aller Geschäftsvorfallsarten pro Nachricht: Anzahl Geschäftsvorfallsarten (BPA, also dieser Wert hier).
* Maximale Anzahl eines bestimmten Segments pro Nachricht: Maximale Anzahl Aufträge (JobParameter des jeweiligen Segments).
*/
val countMaxJobsPerMessage: Int,

View File

@ -3,7 +3,25 @@ package net.codinux.banking.fints.response.segments
open class JobParameters(
open val jobName: String,
/**
* Höchstens zulässige Anzahl an Segmenten der jeweiligen Auftragsart je
* Kundennachricht. Übersteigt die Anzahl der vom Kunden übermittelten Segmente pro Auftragsart die zugelassene Maximalanzahl, so wird die gesamte
* Nachricht abgelehnt.
*/
open val maxCountJobs: Int,
/**
* Anzahl der Signaturen, die zur Ausführung eines Geschäftsvorfalls als erforderlich definiert ist.
* Falls 0 angegeben ist, handelt es sich um einen nicht signierungspflichtigen
* Geschäftsvorfall, der auch über einen anonymen Zugang ohne Signierungsmöglichkeit ausgeführt werden kann.
* Falls die Anzahl der benötigten Signaturen größer als 1 ist, bedeutet dies,
* dass dieser Geschäftsvorfall zusätzlich von mindestens einem anderen berechtigten Benutzer signiert werden muss, über dessen Identität in den UPD
* jedoch nichts ausgesagt wird.
* In bestimmten Fällen ist die Anzahl der Signaturen durch die Art des Geschäftsvorfalls vorgegeben (z. B. sind bei Keymanagement-Aufträgen nicht
* mehrere Signaturen möglich).
*
* (Ist meistens 1, da PinTan Nachrichten außer im Anonymen Dialog immer eigene Signatur brauchen.)
*/
open val minimumCountSignatures: Int,
open val securityClass: Int?,
segmentString: String