Lesen über abstrakte Typen

Worum es geht

Ein abstraktes Modell ist ein Oberbegriff mit mehreren konkreten Untertypen, etwa kunde mit privatkunde und firmenkunde. Wie das grundsätzlich funktioniert, steht unter Abstrakte Modelle und @type.

Diese Seite behandelt den Fall, dass eine Referenz auf ein abstraktes Modell zeigt. Ein Auftrag gehört zu einem Kunden, und dieser Kunde kann ein Privatkunde oder ein Firmenkunde sein. Beim Ausbauen weiß CDMS vorher nicht, welcher Untertyp kommt.

Das Beispielmodell

classDiagram
    class auftrag {
        nummer
        kunde
    }
    class berater {
        name
        kunden
    }
    class kunde {
        <<abstrakt>>
        name
    }
    class privatkunde {
        geburtsdatum
    }
    class firmenkunde {
        handelsregisternummer
    }
    auftrag --> kunde : kunde (einzeln)
    berater --> kunde : kunden (Liste)
    kunde <|-- privatkunde
    kunde <|-- firmenkunde

Wie CDMS die response auflöst

Beim Auflösen der response sieht CDMS, dass kunde abstrakt ist. Es wendet deine innere response auf jeden Untertyp an und vereinigt die Ergebnisse:

flowchart TB
    R["{ field: kunde, response: ['+'] }"] --> P["für privatkunde:<br/>name, geburtsdatum"]
    R --> F["für firmenkunde:<br/>name, handelsregisternummer"]
    P --> U["Vereinigung:<br/>name, geburtsdatum, handelsregisternummer"]
    F --> U
    U --> L["Lesen je Objekt über seinen Untertyp:<br/>Felder, die der Untertyp nicht hat, entfallen"]

Ein + in einer abstrakten Referenz heißt also „alle einfachen Felder aller möglichen Untertypen“. Beim Lesen eines Privatkunden bleibt davon name und geburtsdatum übrig, beim Firmenkunden name und handelsregisternummer.

Einzelreferenz und Liste

Das Ergebnis im Beispiel

POST /api/rest/crm/berater/read/b5…
{
  "response": [
    "name",
    {
      "field": "kunden",
      "response": ["+"],
      "parameter": { "order": [{ "field": "name", "order": "ASC" }] }
    }
  ]
}

{
  "data": {
    "id": "b5…",
    "name": "Petra Berger",
    "kunden": [
      { "@type": "crm.privatkunde", "id": "5a2b…",
        "name": "Anna Muster", "geburtsdatum": "1990-04-01" },
      { "@type": "crm.firmenkunde", "id": "7c1d…",
        "name": "Muster GmbH", "handelsregisternummer": "HRB 12345" }
    ]
  },
  "meta": { "error": false }
}

@type im Client auswerten

@type ist der API-Pfad des Untertyps mit Punkten statt Schrägstrichen. Verzweige im Client darauf, nicht auf die Frage, welche Felder gefüllt sind:

for (const kunde of berater.kunden) {
  switch (kunde["@type"]) {
    case "crm.privatkunde":
      zeigePrivatkunde(kunde);
      break;
    case "crm.firmenkunde":
      zeigeFirmenkunde(kunde);
      break;
  }
}

Entscheidungstabelle

Fallen

Wie es weitergeht

• Grundlagen zu Obermodell, Untertypen und Hub-API: Abstrakte Modelle und @type
• Allgemein zum Ausbauen: Referenzen und Listen ausbauen