Programmieren von GetList()-BAPIs (SAP-Bibliothek - Referenz zum BAPI-Programmierleitfaden (CA-BFA))

Programmieren von GetList()-BAPIs

Verwendung

Das BAPI GetList() dient zur Selektion einer Menge von Objektschlüsselwerten, z.B. Buchungskreisen und Materialnummern und weiteren sinnvollen Werten. Die von diesem BAPI zurückgegebenen Schlüsselwerte können zur weiteren Verarbeitung an ein nachfolgendes BAPI, beispielsweise das BAPI GetDetail(), übergeben werden.

Das BAPI GetList() ist eine Klassenmethode (instanzunabhängig).

Funktionsumfang

Stellen Sie in der Schnittstelle des GetList()-BAPIs alle relevanten Felder bereit. Wie komplex und umfangreich Sie die Schnittstelle gestalten, hängt von den Anforderungen ab, die das jeweilige BAPI erfüllen soll.

Import-Parameter

Bei der Festlegung der Import-Parameter sind folgende Aspekte zu beachten:

Die Schnittstelle eines GetList()-BAPIs muß Selektionsparameter bereitstellen, in denen die gewünschten Selektionsbedingungen vom aufrufenden Programm übergeben werden können. Die Struktur dieser Selektionsparameter ist unter Selektionsparameter beschrieben.

Sie müssen zusätzlich den Parameter MaxRows anlegen, mit dem es möglich ist, die Anzahl der selektierten Einträge zu begrenzen. Mit Hilfe dieses Parameters kann verhindert werden, daß bei ungenauer Angabe der Selektionsparameter eine zu große Wertemenge selektiert wird.
Verwenden Sie als Referenztyp für den Parameter MaxRows das Datenelement BAPIMAXROW.

Soll einem Kunden die Möglichkeit gegeben werden, die Import-Parameter des BAPIs modifikationsfrei zu erweitern, so ist der Parameter ExtensionIn anzulegen.
Informationen zu Extension-Parametern und Empfehlungen, wie das Kundenerweiterungskonzept in einem GetList()-BAPI realisiert werden sollte, finden Sie unter Kundenerweiterung und -modifikation von BAPIs.

Da das GetList()-BAPI eine Klassenmethode ist, darf am Funktionsbaustein kein Parameter angelegt werden, der den gleichen Namen wie ein Schlüsselfeld des zugehörigen Business-Objekttyps besitzt.

Export-Parameter

Bei der Festlegung der Export-Parameter sind folgende Aspekte zu beachten:

Die von dem BAPI GetList() selektierten Werte sollten in einer Tabelle zusammen mit weiteren nützlichen Informationen, beispielsweise Kurztexten, an das aufrufende Programm zurückgeliefert werden.

Soll einem Kunden die Möglichkeit gegeben werden, die Export-Parameter des BAPIs modifikationsfrei zu erweitern, so ist der Parameter ExtensionOut anzulegen.
Informationen zu Extension-Parametern und Empfehlungen, wie das Kundenerweiterungskonzept in einem GetList()-BAPI realisiert werden sollte, finden Sie unter Kundenerweiterung und -modifikation von BAPIs.

Legen Sie den Export-Parameter Return an, um Meldungen aus dem Methodenaufruf an das aufrufende Programm zurückzugeben. Insbesondere im Fehlerfall müssen Meldungen zurückgegeben werden, die den Fehler konkret beschreiben. Deshalb sollte der volle Funktionsumfang der Struktur BAPIRET2 Verwendung finden. Insbesondere sollten die Felder Parameter, Row und Field gefüllt werden.
Informationen zu diesem Parameter finden Sie unter Return-Parameter (Fehlerdarstellung).

Siehe auch:

Beispiel für ein GetList()-BAPI