ResponseControl é retornado no objeto de dados de retorno de uma API de chamada.
Se a chamada da API for manipulada por um adaptador síncrono, então o
controle pode não estar presente no objeto de dados retornado. Se a chamada for
manipulada por um adaptador assíncrono, então esse controle é retornado.
A estrutura de um objeto de dados ResponseControl consiste em:
- concluído
- é uma propriedade
booleana configurada como false se a chamada estiver incompleta.
Após a chamada estar concluída, o sinalizador de concluído é configurado como
true e o objeto de dados retornado contém o resultado da chamada.
- registro
- é uma cadeia que o responsável pela chamada não precisa interpretar. Para uma chamada incompleta, a
propriedade de registro contém uma cadeia de registro que pode ser utilizada no
RequestControl, para verificar o status da chamada da API.
Definição de Esquema XML
A seguir está a definição de esquema XML para o ResponseControl DataObject.
<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>
Objeto de Dados de Amostra
A seguir, o objeto de dados ResponseControl de amostra. Ele é retornado por uma
chamada a uma API que é manipulada por um adaptador assíncrono. A propriedade
concluída no objeto de dados indica que a operação ainda não está concluída e
que o registro pode ser utilizado para rastrear o status da chamada.
<wim:controls xsi:type="wim:ResponseControl" complete="false"
ticket="AsyncLDAP1:1113940307424:-1278154994"/>
A seguir, um objeto de dados ResponseControl de amostra que é retornado após a
chamada assíncrona estar concluída.
<wim:controls xsi:type="wim:ResponseControl" complete="true"/>
Nota: Se a chamada for manipulada por um adaptador síncrono, o ResponseControl pode
não estar presente.