ResponseControl DataObject

ResponseControl は、API 呼び出しの戻りデータ・オブジェクトで戻されます。

API 呼び出しが同期アダプターによって処理された場合は、戻されたデータ・オブジェクトにこのコントロールが存在しないことがあります。 この呼び出しが非同期アダプターによって処理された場合は、このコントロールが戻されます。

ResponseControl DataObject の構造は、以下のものから構成されます。
complete
呼び出しが未完了の場合に false に設定される boolean プロパティーです。 呼び出しが完了すると、完了フラグが true に設定され、戻されるデータ・オブジェクトに呼び出しの結果が含まれます。
ticket
呼び出し側が解釈する必要のないストリングです。 呼び出しが未完了の場合は、API 呼び出しの状況を確認するために RequestControl で使用できるチケット・ストリングが ticket プロパティーに含まれます。

XML スキーマ定義

次に、ResponseControl DataObject の XML スキーマ定義を示します。
<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>

サンプル・データ・オブジェクト

次に、ResponseControl DataObject のサンプルを示します。 これは、非同期アダプターが処理する API 呼び出しによって戻されます。 データ・オブジェクト内の complete プロパティーは、操作がまだ完了していないこと、およびチケットを使用して呼び出しの状況を追跡できることを示します。
<wim:controls xsi:type="wim:ResponseControl" complete="false" 
ticket="AsyncLDAP1:1113940307424:-1278154994"/>
次に、非同期呼び出しの完了後に戻される ResponseControl DataObject のサンプルを示します。
<wim:controls xsi:type="wim:ResponseControl" complete="true"/> 
注: この呼び出しが同期アダプターによって処理された場合は、ResponseControl が存在しないことがあります。


利用条件 | フィードバック