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

Programmieren von GetStatus()-BAPIs

Verwendung

Mit Hilfe des BAPIs GetStatus() können Statusinformationen über eine bestimmte Objektinstanz abgerufen werden.
Das BAPI GetStatus() ist eine Instanzmethode.

Funktionsumfang

Import-Parameter

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

Das BAPI GetStatus() muß als Import-Parameter im Funktionsbaustein die Schlüsselfelder des zugehörigen Business-Objekttyps enthalten. Dabei müssen die Namen dieser Parameter mit den Namen der Objektschlüssel im BOR übereinstimmen und die gleichen Datenelemente besitzen.

Bei der entsprechenden Methodendefinition im BOR dürfen die Schlüsselfelder jedoch nicht zusätzlich als Parameter aufgeführt werden. Aus diesem Grund nimmt der BOR/BAPI-Wizard beim Anlegen eines BAPIs die Funktionsbaustein-Parameter für die Schlüsselfelder nicht in die Methodendefinition auf.

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 GetStatus()-BAPI realisiert werden sollte, finden Sie unter Kundenerweiterung und -modifikation von BAPIs.

Export-Parameter

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

Die Export-Parameter des BAPIs enthalten die Statusinformationen zu der Objektinstanz.

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 GetStatus()-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 des Typs 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 GetStatus()-BAPI