PageControl DataObject

PageControl を使用すれば、アプリケーションに検索結果の追加ページを取得させることができます。

PageControl DataObject の構造は、以下のものから構成されます。
size
ページのサイズを指定します。
cookie
サーバーが検索の次のページを取得できるようにするために PageResponseControl から戻された Cookie を含みます。 ページ検索の最初の呼び出しでは、このプロパティーはどの値にも設定されません。
注: SearchControl に countLimit プロパティーが指定されている場合は、PageControl を使用できません。 これらは相互に排他的です。

XML スキーマ定義

次に、PageControl DataObject の XML スキーマ定義を示します。
<xsd:complexType name="PageControl">
	<xsd:complexContent>
		<xsd:extension base="Control">
			<xsd:attribute name="size" type="xsd:int"/>
			<xsd:attribute name="cookie" type="xsd:hexBinary"/>
		</xsd:extension>
	</xsd:complexContent>
	</xsd:complexType>

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

次に、最初のページの search API で使用される PageControl DataObject のサンプルを示します。 このデータ・オブジェクトには cookie プロパティーはありません。 検索結果が 10 件を超える場合でも、10 件のみを戻すように指定しています。
<controls xsi:type="PageControl" size="10"/>
次に、後続のページの search API で使用される PageControl DataObject のサンプルを示します。 PageResponseControl から戻された cookie プロパティーが設定されます。
<wim:controls xsi:type="wim:PageControl" 
     cookie="57494D53656172636843616368654E616D6574696D653A31313239353538343136383636"
     size="10"/>
次に、検索の停止を指示するために search API で使用される PageControl DataObject のサンプルを示します。 ページ検索結果を停止するには、設定された cookie を使用してページ・サイズを 0 に設定します。
<wim:controls xsi:type="wim:PageControl" 
   cookie="57494D53656172636843616368654E616D6574696D653A31313239353538343136383636" 
   size="0"/>


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