ResponseControl DataObject

ResponseControl se devuelve en el objeto de datos de retorno de una llamada de API.

Si un adaptador síncrono maneja la llamada de API, puede que este control no esté presente en el objeto de datos devuelto. Si un adaptador asíncrono maneja la llamada, se devuelve este control.

La estructura de un objeto de datos ResponseControl está formada por los elementos siguientes:
complete
es una propiedad booleana que se establece en false (falso) si la llamada está incompleta. Una vez completada la llamada, el distintivo complete se establece en true (verdadero) y el objeto de datos devuelto contiene el resultado de la llamada.
ticket
es una serie que no es necesario que el llamante interprete. Para una llamada incompleta, la propiedad ticket contiene una cadena "ticket" que se puede utilizar en RequestControl para comprobar el estado de la llamada de API.

Definición de esquema XML

A continuación se proporciona la definición del esquema XML para 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>

Objetos de datos de ejemplo

A continuación se proporciona un objeto de datos ResponseControl de ejemplo. Lo devuelve una llamada a una API manejada por un adaptador asíncrono. La propiedad complete del objeto de datos indica que la operación todavía no se ha completado y que se puede utilizar el tíquet para realizar un seguimiento del estado de la llamada.
<wim:controls xsi:type="wim:ResponseControl" complete="false" 
ticket="AsyncLDAP1:1113940307424:-1278154994"/>
A continuación se proporciona un objeto de datos ResponseControl de ejemplo que se devuelve después de completarse la llamada asíncrona.
<wim:controls xsi:type="wim:ResponseControl" complete="true"/> 
Nota: Si un adaptador síncrono maneja la llamada, puede que ResponseControl no esté presente.


Condiciones de uso | Comentarios