faqメソッドでは以下のパラメータを使用します。
|
パラメータ |
型 |
説明 |
|---|---|---|
|
SID |
Integer |
ログインにより取得したセッションを指定します。 |
|
categoryIds |
String |
faqの実行に使用するカテゴリIDを指定します。 「ルート」カテゴリには1を使用します。 注： 「1, 2, 3」のように複数の ID を指定できます。 |
|
resultSize |
Integer |
詳細情報を取得するドキュメントの数を指定します。 残りのドキュメントについてはIDのみが返されます。 これらのドキュメントの詳細情報には、後からgetDocumentsByIDs()メソッドを使用してアクセスすることができます。 初期設定は10です。 |
|
propertyList |
String |
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。
|
|
sortBy |
String |
結果の並べ替えに使用するデータベース フィールドを指定します。 複数の並べ替えフィールドを指定することはできません。 初期設定はBU_RESULTで、FAQ評価による並べ替えが実行されます。 指定したフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。 |
|
descending |
Boolean |
結果を降順で並べ替えるかどうかを指定します。 |
|
whereClause |
String |
このパラメータを使用して、「SQLのWhere節」を追加し、検索結果をフィルタリングします。 |
|
maxDocIds |
Integer |
返されるドキュメントIDの最大数を指定します（初期設定は100）。 たとえば、resultSizeに10、maxDocIdsに50を指定し、一致するドキュメントがデータベースに100個あった場合、そのうちの10個については詳細情報が取得され、40個についてはIDのみが返されます。 残りの50ドキュメントについては何も返されません。 |
説明
FAQ 検索の実行に使用します。 ドキュメントは、渡したカテゴリIDに基づいて取得されます。 そのカテゴリ、またはサブカテゴリにあるドキュメントが返されます。 パフォーマンスを向上するため、これらのメソッドはresultSizeパラメータで指定したユーザ定義のドキュメント セットの詳細情報のみを取得します。 残りのドキュメントについてはIDのみが返されます。 このメソッドを使用すると、たとえば、［先頭］、［戻る］、［次へ］、［最後］といったリンクをクリックしてページ間を移動できるようにセットアップできます。 次のドキュメント セットを取得する場合は、getDocumentsByIDs()メソッドを使用できます。 最大100個のIDが返されます。
戻り値
<UDSObjectList>ノード。ノード内に以下のセクションが返されます。
本章の<UDSObject>ノードの説明セクションで説明されている<UDSObject>ノード。 n が resultSize パラメータに指定した値に等しい場合、このメソッドで検出される最初の n 個のドキュメントについて、<UDSObject> ノードとそのすべてのプロパティが返されます。
たとえば、resultSizeパラメータに10、maxDocIDsパラメータに50を指定し、メソッドが100個のドキュメントを見つけた場合、10個の<UDSObject>ノードがpropertyListパラメータで指定した属性の詳細情報を含む<Attributes>セクションと共に返され、40個の<UDSObject>がIDプロパティのみを含む<Attributes>セクションと共に返されます。 11～20番目のドキュメントID <AttrName>の詳細情報を取得する場合は、getDocumentsByIDs()メソッドをコールして、<AttrValue>のIDを渡す必要があります。
|
Copyright © 2013 CA.
All rights reserved.
|
|