executeProcedure

executeProcedure est l'appel d'API pris en charge par le service Web.

Syntaxe

executeProcedure(string key, string jobid, NameValueArrays paramArray)

Renvoie

int: status
Message[]: messages

Description

Cette méthode appelle la procédure spécifiée avec une matrice de paramètres facultatifs. L'appel s'exécute de façon synchrone, c'est-à-dire qu'il bloque le client et renvoie le résultat à l'achèvement de l'exécution.

Paramètres

Tableau 1. Paramètres executeProcedure
Nom Description
key Clé unique de la procédure à exécuter. Une erreur RemoteException est renvoyée si aucune procédure n'est liée à key.
ID de travail Chaîne facultative qui identifie le travail associé à l'exécution de cette procédure. Cette chaîne est un élément passe-système mais elle peut être utilisée pour lier des tâches client à l'exécution d'une procédure particulière.
paramArray Une matrice de paramètres à transmettre à la procédure. Un état et un message d'erreur sont renvoyés si un ou plusieurs des paramètres sont non valides (par exemple, type non valide ou valeur incorrecte). C'est au client qu'il revient de déterminer les paramètres, leur type et le nombre de valeurs requises par la procédure.

Paramètres de retour

Tableau 2. Paramètres de retour de executeProcedure
Nom Description
Etat Code entier :
  • 0 indique que l'exécution de la procédure a abouti
  • un entier indique une erreur

Les procédures peuvent utiliser l'état pour indiquer différents niveaux d'erreur.

messages Une matrice de zéro ou plusieurs structures de données de message. Si status a pour valeur 0, cette matrice ne contient pas de messages d'ERREUR mais peut contenir des messages d'INFORMATION et d'AVERTISSEMENT.

Si status est différent de zéro, les messages peuvent contenir un mélange de messages d'ERREUR, d'INFORMATION et d'AVERTISSEMENT.