ResponseControl
est retourné dans l'objet de données renvoyé d'un appel de l'interface de
programme d'application.
Si l'appel de l'interface de programme d'application est géré par un
adaptateur synchrone, ce contrôle peut être absent de l'objet de
données renvoyé. Si l'appel est géré par un adaptateur asynchrone, alors
ce contrôle est renvoyé.
La
structure d'un objet de données ResponseControl se compose des éléments suivants :
- complete
- propriété booléenne
qui est définie sur False si l'appel est inachevé.
Une fois l'appel terminé, l'indicateur de fin est défini sur True et l'objet de
données renvoyé contient le résultat de l'appel.
- ticket
- chaîne que l'appelant n'a
pas besoin d'interpréter. Pour un appel inachevé, la propriété de ticket
contient une chaîne de ticket qui peut être utilisée dans RequestControl pour
vérifier l'état de l'appel de l'API.
Définition de schéma XML
Vous
trouverez ci-dessous la définition du schéma XML pour l'objet de données ResponseControl.
<xsd:complexType name="ResponseControl">
<xsd:complexContent>
<xsd:extension base ="Control">
<xsd:attribute name="complete" type="xsd:boolean" default="true"/>
<xsd:attribute name="ticket" type="xsd:string"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Objets de données exemple
Voici
un exemple d'objet de données ResponseControl. Il est renvoyé par un appel
vers une API qui est gérée par un adaptateur asynchrone. La
propriété complète de l'objet de données indique que l'opération n'est pas
encore achevée et que vous pouvez utiliser le ticket pour suivre l'état de
l'appel.
<wim:controls xsi:type="wim:ResponseControl" complete="false"
ticket="AsyncLDAP1:1113940307424:-1278154994"/>
Voici
un exemple d'objet de données ResponseControl qui est renvoyé dès que l'appel
asynchrone est terminé.
<wim:controls xsi:type="wim:ResponseControl" complete="true"/>
Remarque : Si
l'appel est géré par un adaptateur synchrone, ResponseControl peut être
absent.