searchメソッドでは以下のパラメータを使用します。
|
パラメータ |
型 |
説明 |
|---|---|---|
|
SID |
Integer |
ログインにより取得したセッションを指定します。 |
|
問題 |
String |
解決策を検索する問題の説明を指定します。 |
|
resultSize |
Integer |
詳細情報を取得するドキュメントの数を指定します。 残りのドキュメントについては、IDのみが返されます。 これらのドキュメントの詳細情報には、後からgetDocumentsByIDs()メソッドを使用してアクセスすることができます。 初期設定は10です。 |
|
propertyList |
String |
情報を取得するデータベース フィールドをカンマ区切りリストで指定します。 propertyListパラメータに関わらず、常に以下のフィールドが返されます。
|
|
sortBy |
String |
結果の並べ替えに使用するデータベース フィールドを指定します。 複数の並べ替えフィールドを指定することはできません。 初期設定はRELEVANCEです。 指定したフィールドで並べ替えられてから、常に ID での並べ替えが実行されます。 有効な並べ替えプロパティについては、「faqメソッド」を参照してください。 |
|
descending |
Boolean |
結果を降順で並べ替えるかどうかを指定します。 |
|
relatedCategories |
Boolean |
見つかったドキュメントのすべての関連カテゴリのリストを返すかどうかを指定します。 |
|
searchType"¥y"searchType |
Integer |
実行する検索のタイプを指定します。
|
|
matchType |
Integer |
一致タイプを指定します。
注: searchType パラメータとして NLS が選択された場合は、OR と AND の matchType のみが有効です。 |
|
searchField |
Integer |
検索を行うフィールドのバイナリ値の組み合わせを指定します。
たとえば、すべてのフィールドを検索する場合は、15(1+2+4+8)を指定します。 概要と問題のみを検索するには、6(2+4)を指定します。 注: デフォルトでは問題が検索されます。 searchType パラメータを NLS に設定すると、searchFields パラメータは無視されます。NLS 検索では問題フィールドしか検索できないためです。 |
|
categoryPath |
String |
検索結果を特定のカテゴリに制限します。 カテゴリIDの完全パスを指定する必要があります。複数のカテゴリを指定する場合はカンマで区切ります。 たとえば、「1-3-5, 1-4-8」と指定すると、カテゴリ5および8(およびそのサブカテゴリ)に検索が制限されます。 |
|
whereClause |
String |
このパラメータを使用して、「SQLのWhere節」を追加し、検索結果をフィルタリングします。 |
|
maxDocIds |
Integer |
返されるドキュメントIDの最大数を指定します。 たとえば、resultSizeに10、maxDocIdsに50を指定し、一致するドキュメントがデータベースに100個あった場合、そのうちの10個については詳細情報が取得され、40個についてはIDのみが返されます。 残りの50ドキュメントについては何も返されません。 初期設定は100です。 |
説明
問題の解決策を検索します。 ドキュメントは、渡した問題に基づいて取得されます。 問題の説明に一致、または類似するドキュメントが返されます。 パフォーマンスを向上するため、これらのメソッドはresultSizeパラメータで指定したユーザ定義のドキュメント セットの詳細情報のみを取得します。 残りのドキュメントについては ID のみが返されます。 このメソッドを使用すると、たとえば、[先頭]、[戻る]、[次へ]、[最後]といったリンクをクリックしてページ間を移動できるようにセットアップできます。 次のドキュメント セットを取得する場合は、getDocumentsByIDs()メソッドを使用できます。
戻り値
<UDSObjectList>ノード。ノード内に以下のセクションが返されます。
本章の<UDSObject>ノードの説明セクションで説明されている<UDSObject>ノード。 n が resultSize パラメータに指定した値に等しい場合、このメソッドで検出される最初の n 個のドキュメントについて、<UDSObject> ノードとそのすべてのプロパティが返されます。 たとえば、resultSize パラメータに 10、maxDocIDs パラメータに 50 を指定し、メソッドが 100 個のドキュメントを見つけた場合、10 個の <UDSObject> ノードがリクエストしたすべてのプロパティを含む <Attributes> セクションと共に返され、40 個の <UDSObject> が ID プロパティのみを含む <Attributes> セクションと共に返されます。 11~20番目のドキュメントの詳細な<UDSObject>情報を取得する場合は、getDocumentsByIDs()メソッドをコールして、これらのIDを渡す必要があります。
getRelatedCategoriesパラメータをTrueに設定すると、関連カテゴリ用の<UDSObjectList>ノードが<Attributes>セクションに含まれます。 各 <INDEX_DOC_LINKS> ノードには、以下のようにカテゴリの関係付け ID が含まれます。
1-70
|
Copyright © 2013 CA.
All rights reserved.
|
|