Seitenhistorie
Ziel dieses Schrittes ist, das tatsächlich im Zielnuclet verwendeten Businessobjekt an den Java-Code des SEPA-Nuclets anzubinden. Dazu wird der Ansatz verfolgt, Nuclet-unabhängige Wrapper-Klassen zu verwenden – anstelle der zu den Businessobjekten generierten Businessobjekt-Klassen.
Zu den technischen Hintergründen lesen Sie dazu bitte auch den Artikel "Schnittstellen in Java-Regeln".
Hinweis |
---|
Dieser Integrationsschritt kann erst durchgeführt werden, sobald die Vorbedingungen aus Abschnitt 3 erfüllt sind – d.h. sobald entsprechende Attribute in den genutzten Businessobjekten existieren. |
Bei der Anbindung des SEPA-Nuclets sind Wrapper-Klassen für Debitoren (Kunden, o.ä.), Referenzen (Rechnungen, Belege, o.ä.) und Zahlungsreferenzen (Forderungen, Rechnungspositionen, o.ä.) anzupassen.
Wrapper-Klasse | Funktion | Java-Package |
---|---|---|
DebitorWrapper | Anbindung an verwendete Debitoren, Kunden, o.ä. | org.nuclet.sepa.wrapper |
ReferenceWrapper | Anbindung an genutzte Referenzobjekte (Rechnungen,o.ä.) | org.nuclet.sepa.wrapper |
PaymentReferenceWrapper | Anbindung an verwendete Zahlungsreferenzobjekte (Forderungen, Rechnungspositionen, etc.) | org.nuclet.mt940.wrapper |
Tabelle 4.8.1: Übersicht Nuclet-Schnittstellen
Info |
---|
Bitte beachten Sie, dass es in diesem Integrationsschritt nur darum geht, die Anbindung an die Attribute der tatsächlich genutzten Businessobjekte herzustellen. Es ist von Ihnen an dieser Stelle im Normalfall keinerlei Prozesslogik zu implementieren. |
4.7.1.1 DebitorWrapper
Die Klasse DebitorWrapper dient als Nuclet-Schnittstelle zum tatsächlich genutzten Debitoren-Businessobjekt.
Der Konstruktor der Klasse und die Methode getIso4217Code() sind mit anwendungsspezifischem Verhalten zu befüllen. Letztere Methode sollte den ISO-4217-Währungscode (siehe dazu Wikipedia) des Währunsobjektes zurückliefern.
Methode | Funktion | Anpassung optional? |
---|---|---|
DebitorWrapper | Zuordnung des tatsächlich genutzten Businessobjektes | nein |
| ||
getBic() | liefert die BIC des Debitoren, d.h. das Geschäftskennzeichen der Bank des Debitoren (BIC = Business Identifier Code, früher: Bank Identifier Code) | nein |
getDateOfSEPAMandateSignature() | liefert das Datum, an dem das SEPA-Mandat vom Debitoren ausgestellt/unterzeichnet wurde | nein |
getHasSEPAMandateChanged() | liefert Informationen darüber, ob sich das SEPA-Mandat des Debitoren verändert hat (d.h. ob die Bankverbindung geändert wurde) | nein |
getIban() | liefert die IBAN des Debitoren, d.h. die internationale Bankkontonummer (IBAN = International Bank Account Number) | nein |
getIsNewDebitorAgent() | liefert Informationen darüber, ob der Debitor seit dem letzten SEPA-Exort das Kreditinstitut gewechselt hat | nein |
getName() | liefert den Namen des Debitoren | nein |
getOriginalDebitorAccount() | liefert die letzte IBAN des Debitoren, falls sich diese seit dem letzten SEPA-Export geändet haben sollte | nein |
getSEPAMandateIdentification() | liefert die SEPA-Mandatskennung des Debitoren | nein |
getSEPASequenceTypeId() | liefert die SEPA-Laufzeit für den Debitoren (ist die SEPA-Lastschrift erstmals, einmalig oder wiederkehrend?) | nein |
setHasSEPAMandateChanged() | setzt Informationen darüber, ob sich das SEPA-Mandat des Debitoren verändert hat (d.h. ob die Bankverbindung geändert wurde) | nein |
setIsNewDebitorAgent() | setzt Informationen darüber, ob der Debitor seit dem letzten SEPA-Exort das Kreditinstitut gewechselt hat | nein |
setOriginalDebitorAccount() | setzt die letzte IBAN des Debitoren, falls sich diese seit dem letzten SEPA-Export geändet haben sollte | nein |
setSEPASequenceTypeId() | setzt die SEPA-Laufzeit für den Debitoren (ist die SEPA-Lastschrift erstmals, einmalig oder wiederkehrend?) | nein |
Tabelle 4.7.1.1: Anpassungen in DebitorWrapper
Beispiele dazu sind in Kommentarblöcken angegeben; diese Beispiele sind bei der Integration also an die tatsächlich genutzte Währungsbusinessobjekt (bzw. deren BusinessObject-Klasse) anzupassen.
Codeblock | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
package org.nuclet.sepa.wrapper; import java.math.BigDecimal; import java.util.Date; import java.util.List; import org.nuclos.api.businessobject.BusinessObject; import org.nuclos.api.businessobject.facade.Modifiable; import org.nuclos.api.businessobject.facade.Stateful; // @replace! // // import org.nuclet.businesstemplate.Client; /** * Wrapper implementation for debitors * * @version 1.0 * @date 21.03.2014 * @nuclet org.nuclet.SEPA * @nucletversion 1.0.0 * @sincenucletversion 1.0.0 * @since 21.03.2014 * * @author frank.lehmann@nuclos.de * */ public class DebitorWrapper extends AbstractDebitorWrapper { public DebitorWrapper(final Modifiable reference) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // if (reference instanceof Client) { // this.businessObject = reference; // } } /** * Liefert den Namen des Debitors * */ public String getName() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getName(); return null; } /** * Liefert die SEPA-Mandatskennung */ public String getSEPAMandateIdentification() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getSEPAMandateIdentification(); return null; } /** * Liefert das Ausstellungsdatum des SEPA-Mandats */ public Date getDateOfSEPAMandateSignature() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getDateOfSEPAMandateSignature(); return null; } /** * Liefert Informationen darüber, ob sich das SEPA-Mandat auf Debitorenseite * geändert hat */ public Boolean getHasSEPAMandateChanged() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getHasSEPAMandateChanged(); return null; } /** * Setzt die Informationen darüber, ob sich das SEPA-Mandat auf Debitorenseite * geändert hat */ public void setHasSEPAMandateChanged(final Boolean blnHasSEPAMandateChanged) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // ((Client)this.businessObject).setHasSEPAMandateChanged(blnHasSEPAMandateChanged); } /** * Liefert Informationen darüber, ob sich das Kreditinstitut auf Debitorenseite * gewechselt wurde */ public Boolean getIsNewDebitorAgent() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getIsNewDebitorAgent(); return null; } /** * Setzt die Informationen darüber, ob sich das Kreditinstitut auf Debitorenseite * gewechselt wurde */ public void setIsNewDebitorAgent(final Boolean blnIsNewDebitorAgent) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // ((Client)this.businessObject).setIsNewDebitorAgent(blnIsNewDebitorAgent); } /** * Liefert die Datenbank-ID der SEPA-Laufzeit * */ public Long getSEPASequenceTypeId() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getSEPASequenceTypeId(); return null; } /** * Setzt die Datenbank-ID der SEPA-Laufzeit * */ public void setSEPASequenceTypeId(final Long lngSEPASequenceTypeId) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // ((Client)this.businessObject).setSEPASequenceTypeId(lngSEPASequenceTypeId); } /** * Liefert den BIC für SEPA-Zahlungen * */ public String getBic() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getBic(); return null; } /** * Liefert den IBAN für SEPA-Zahlungen * */ public String getIban() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getIban(); return null; } /** * Liefert die alte IBAN bei SEPA-Mandatsänderungen * */ public String getOriginalDebitorAccount() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((Client)this.businessObject).getOriginalDebitorAccount(); return null; } /** * Setzt die alte IBAN bei SEPA-Mandatsänderungen * */ public void setOriginalDebitorAccount(final String strOriginalDebitorAccount) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // ((Client)this.businessObject).setOriginalDebitorAccount(strOriginalDebitorAccount); } } |
4.8.1.2 ReferenceWrapper
Die Klasse ReferenceWrapper dient als Nuclet-Schnittstelle für tatsächlich genutzte Referenzobjekte (Rechnungen, Forderungen, Belege, etc.).
Das sind jene Objekte, die bei SEPA-Exporten als Referenz für Zahlungsanweisungen verwendet werden.
Methode | Funktion | Anpassung optional? |
---|---|---|
ReferenceWrapper | Zuordnung des tatsächlich genutzten Businessobjektes | nein |
getDebitorId() | liefert die Datenbank-ID des Debitoren | ja |
getDirectDebitReference() | liefert das Identifizierungsmerkmal für Lastschriften (also z.B. die Rechnungsnummer) | ja |
getReferenceDate() | liefert ein Referenzdatum (bspw. das Rechnungsdatum) | ja |
Tabelle 4.7.1.2: Anpassungen in ReferenceWrapper
Beispiele dazu sind in Kommentarblöcken angegeben; diese Beispiele sind bei der Integration also an das tatsächlich genutzte Businessobjekt (bzw. deren BusinessObject-Klasse) anzupassen.
Codeblock | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
package org.nuclet.sepa.wrapper; import java.math.BigDecimal; import java.util.Date; import java.util.List; import org.nuclos.api.businessobject.BusinessObject; import org.nuclos.api.businessobject.facade.Modifiable; import org.nuclos.api.businessobject.facade.Stateful; // @replace! // // import org.nuclet.businesstemplate.ClientBilling; /** * Abstract wrapper class for debitors (client billings, invoices, etc.) * * @version 1.0 * @date 21.03.2014 * @nuclet org.nuclet.SEPA * @nucletversion 1.0.0 * @sincenucletversion 1.0.0 * @since 21.03.2014 * * @author frank.lehmann@nuclos.de * */ public class ReferenceWrapper extends AbstractReferenceWrapper { public ReferenceWrapper(final Modifiable reference) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // if (reference instanceof ClientBilling) { // this.businessObject = reference; // } } /** * Liefert die Datenbank-ID des Debitoren * */ public Long getDebitorId() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((ClientBilling)this.businessObject).getClientId(); return null; } /** * Liefert das Identifizierungsmerkmal für Lastschriften (z.B. die Rechnungsnummer) * */ public String getDirectDebitReference() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // // return ((ClientBilling)this.businessObject).getBillingNumber(); return null; } /** * Liefert ein Referenzdatum (bspw. das Rechnungsdatum) * */ public Date getReferenceDate() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((ClientBilling)this.businessObject).getBillingDate(); return null; } } |
4.7.1.3 PaymentReferenceWrapper
Die Klasse PaymentReferenceWrapper dient als Nuclet-Schnittstelle zum tatsächlich genutzten Businessobjekt für Zahlungsreferenzen.
Mit Zahlungsreferenzen sind jene Objekte gemeint, :
Methode | Funktion | Anpassung optional? |
---|---|---|
PaymentReferenceWrapper() | Zuordnung des tatsächlich genutzten Businessobjektes | nein |
getAmount() | liefert den zu zahlenden Betrag | nein |
getReferenceId() | liefert die Datenbank-ID des übergeordneten Referenzobjektes (siehe 4.7.1.2) | nein |
setSEPAExportDate() | setzt das Export-Datum nach erfolgtem SEPA-Export | nein |
setSEPAPaymentInformationId() | setzt die SEPA-Zahlungsinformation nach erfolgtem SEPA-Export | nein |
Tabelle 4.7.1.3: Anpassungen in PaymentReferenceWrapper
Beispiele dazu sind in Kommentarblöcken angegeben; diese Beispiele sind bei der Integration also an das tatsächlich genutzte Businessobjekt (bzw. deren BusinessObject-Klasse) anzupassen.
Codeblock | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
package org.nuclet.sepa.wrapper; import java.math.BigDecimal; import java.util.Date; import java.util.List; import org.nuclos.api.businessobject.BusinessObject; import org.nuclos.api.businessobject.facade.Modifiable; import org.nuclos.api.businessobject.facade.Stateful; // @replace! // // import org.nuclet.businesstemplate.ClientBillingPosition; /** * Wrapper implementation for SEPA references (invoices, due payments, etc.) * * @version 1.0 * @date 21.03.2014 * @nuclet org.nuclet.SEPA * @nucletversion 1.0.0 * @sincenucletversion 1.0.0 * @since 21.03.2014 * * @author frank.lehmann@nuclos.de * */ public class PaymentReferenceWrapper extends AbstractPaymentReferenceWrapper { public PaymentReferenceWrapper(final Modifiable reference) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // if (reference instanceof ClientBillingPosition) { // this.businessObject = reference; // } } /** * Liefert die Datenbank-ID des übergeordneten Referenzobjektes * (also bspw. die ID der Rechnung, falls es sich bei den Zahlungsreferenzen um * Rechnungspositionen handelt) * */ public Long getReferenceId() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((ClientBillingPosition)this.businessObject).getClientBillingId(); return null; } /** * Liefert den Zahlungsbetrag * */ public BigDecimal getAmount() { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // return ((ClientBillingPosition)this.businessObject).getAmount(); return null; } public void setSEPAPaymentInformationId(final Long lngSEPAPaymentInformationId) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // ((ClientBillingPosition)this.businessObject).setSEPAPaymentInformationId(lngSEPAPaymentInformationId); } public void setSEPAExportDate(final Date datSEPAExportDate) { // @replace! Bitte bei Nuclet-Integration mit eigenem Code ersetzen! // // Beispiel: // // ((ClientBillingPosition)this.businessObject).setSEPAExportDate(datSEPAExportDate); } } |