jp.co.intra_mart.foundation.contentssearch.service

インタフェース SearchService

既知の実装クラスのリスト:

StandardSearchService

public interface SearchService

検索機能を提供するサービスのインターフェースです。

導入されたバージョン:

8.0.0

バージョン:

8.0.3

メソッドのサマリー

修飾子とタイプ	メソッドと説明
SearchService	addACIBuilder(ACIBuilder... builders) 検索時の権限を作成するACIビルダーを与えられたビルダーを追加します。
long	getNumberOfContents() 検索サーバに登録されている総コンテンツ数を取得します。
SearchResponse	search(SearchQuery query) 与えられた検索条件で全文検索を行い結果を返します。
SearchService	setACIBuilder(ACIBuilder... builders) 検索時の権限を作成するACIビルダーを与えられたビルダーコレクションに変更します。
SearchService	setACIBuilder(Collection<? extends ACIBuilder> builders) 検索時の権限を作成するACIビルダーを与えられたビルダーコレクションに変更します。

メソッドの詳細

search

SearchResponse search(SearchQuery query)
               throws ContentsSearchExecutionException,
                      InvalidSearchConditionException

与えられた検索条件で全文検索を行い結果を返します。

パラメータ:

query - 検索クエリ

戻り値:

検索結果

例外:

ContentsSearchExecutionException - 検索に失敗した場合

InvalidSearchConditionException - 不正な検索クエリが指定された場合

addACIBuilder

SearchService addACIBuilder(ACIBuilder... builders)

検索時の権限を作成するACIビルダーを与えられたビルダーを追加します。

パラメータ:

builders - ビルダー

戻り値:

検索サービス

例外:

NullPointerException - 指定されたコレクションが null である場合

setACIBuilder

SearchService setACIBuilder(Collection<? extends ACIBuilder> builders)

検索時の権限を作成するACIビルダーを与えられたビルダーコレクションに変更します。

パラメータ:

builders - ビルダーのコレクション

戻り値:

検索サービス

例外:

NullPointerException - 指定されたコレクションが null である場合

setACIBuilder

SearchService setACIBuilder(ACIBuilder... builders)

検索時の権限を作成するACIビルダーを与えられたビルダーコレクションに変更します。

パラメータ:

builders - ビルダー

戻り値:

検索サービス

例外:

NullPointerException - 指定されたビルダーが null である場合

getNumberOfContents

long getNumberOfContents()
                  throws ContentsSearchExecutionException

検索サーバに登録されている総コンテンツ数を取得します。

戻り値:

総コンテンツ数

例外:

ContentsSearchExecutionException - 総コンテンツ数の取得に失敗した場合