executeProcedure

executeProcedure ist der vom Web-Service unterstützte API-Aufruf.

Syntax

executeProcedure(string key, string jobid, NameValueArrays paramArray)

Rückgabe

int: status
Message[]: messages

Beschreibung

Diese Methode ruft die angegebene Prozedur mit einem optionalen Array von Parametern auf. Der Aufruf wird synchron ausgeführt, das heißt, der Client wird blockiert und bei Abschluss des Aufrufs wird das Ergebnis ausgegeben.

Parameter

Tabelle 1. executeProcedure-Parameter
Name Beschreibung
Schlüssel Der eindeutige Schlüssel der auszuführenden Prozedur. Es wird ein RemoteException-Fehler zurückgegeben, wenn an Schlüssel keine Prozedur gebunden ist.
jobid Optionale Zeichenfolge, die den Job ermittelt, der der Ausführung dieser Prozedur zugeordnet ist. Diese Zeichenfolge ist ein Durchgriffselement, sie kann jedoch verwendet werden, um Clientjobs an die Ausführung einer bestimmten Prozedur zu binden.
paramArray Ein Array aus Parametern, das an die Prozedur übergeben werden soll. Es werden ein Fehlerstatus und eine Fehlernachricht zurückgegeben, wenn mindestens ein Parameter ungültig ist (beispielsweise ein falscher Typ oder ein unzulässiger Wert). Es ist dem Client überlassen, die Parameter, ihre Typen und die Anzahl der Werte zu bestimmen, die für die Prozedur erforderlich sind.

Rückgabeparameter

Tabelle 2. Rückgabeparameter für „executeProcedure“
Name Beschreibung
Status Ein ganzzahliger Code:
  • 0 gibt an, dass die Prozedur erfolgreich ausgeführt wurde
  • eine ganze Zahl gibt einen Fehler an

Prozeduren können über den Status verschiedene Fehlerstufen angeben.

Nachrichten Ein Array aus null oder mehr Nachrichtendatenstrukturen. Wenn status den Wert 0 hat, enthält dieses Array keine ERROR-Nachrichten, kann jedoch INFORMATION- und WARNING-Nachrichten enthalten.

Wenn status einen anderen Wert als 0 hat, können die Nachrichten aus einer beliebigen Kombination aus ERROR-, INFORMATION- und WARNING-Nachrichten bestehen.