CTR NEX API Reference
nn::nex::DataStoreSearchParam クラス

メタ情報の検索に関するパラメータを表すクラスです。 [詳解]

#include <RendezVous/Services/Jugem/DataStore/src/Common/DataStoreSearchParam.h>

DDLCLASSDataStoreSearchParamを継承しています。

公開メンバ関数

 DataStoreSearchParam ()
 コンストラクタです。
 
virtual ~DataStoreSearchParam ()
 デストラクタです。
 
const DateTimeGetCreatedAfter () const
 検索するアップロードされた日時の開始点を取得します。 [詳解]
 
const DateTimeGetCreatedBefore () const
 検索するアップロードされた日時の終了点を取得します。 [詳解]
 
qUnsignedInt16 GetDataType () const
 検索するデータタイプを 1 つ取得します。 [詳解]
 
void GetDataType (qVector< qUnsignedInt16 > &dataTypes_) const
 検索するデータタイプのリストを取得します。 [詳解]
 
const qVector< PrincipalID > & GetDestinationIds () const
 検索する参照権限保持者の プリンシパル ID を取得します。 [詳解]
 
qUnsignedInt32 GetMinimalRatingFrequency ()
 最低評価回数を取得します。 [詳解]
 
const qVector< PrincipalID > & GetOwnerIds () const
 検索するアップロードした人の プリンシパル ID を取得します。 [詳解]
 
DataStoreConstants::SearchTarget GetOwnerType () const
 検索するアップロードした人の プリンシパル ID のタイプを取得します。 [詳解]
 
qByte GetResultOption () const
 検索の戻り値オプションを取得します。 [詳解]
 
const ResultRangeGetResultRange () const
 検索範囲を取得します。 [詳解]
 
DataStoreConstants::SearchSortOrder GetSearchSortOrder () const
 検索結果のソート順を取得します。 [詳解]
 
DataStoreConstants::SearchSortColumn GetSearchSortOrderColumn () const
 検索結果のソート対象とするカラムを取得します。 [詳解]
 
DataStoreConstants::SearchType GetSearchType () const
 検索タイプを取得します。 [詳解]
 
const qVector< String > & GetTags () const
 検索するタグを取得します。 [詳解]
 
qBool GetTotalCountEnabled ()
 検索条件に一致した総数を取得するかどうかを取得します。 [詳解]
 
const DateTimeGetUpdatedAfter () const
 検索する更新日時の開始点を取得します。 [詳解]
 
const DateTimeGetUpdatedBefore () const
 検索する更新日時の終了点を取得します。 [詳解]
 
qBool GetUseCache ()
 検索結果のキャッシュを使用するかどうかを取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetCreatedAfter (const DateTime &createdAfter_)
 検索するアップロードされた日時の開始点をセットします。 [詳解]
 
void SetCreatedBefore (const DateTime &createdBefore_)
 検索するアップロードされた日時の終了点をセットします。 [詳解]
 
void SetDataType (const qUnsignedInt16 dataType_)
 検索するデータタイプ 1 つをセットします。 [詳解]
 
void SetDataType (const qVector< qUnsignedInt16 > &dataTypes_)
 検索するデータタイプのリストをセットします。 [詳解]
 
void SetDestinationIds (const qVector< PrincipalID > &destinationIds_)
 検索する参照権限保持者の プリンシパル ID をセットします。 [詳解]
 
void SetMinimalRatingFrequency (const qUnsignedInt32 minimalRatingFrequency_)
 最低評価回数をセットします。 [詳解]
 
void SetOwnerIds (const qVector< PrincipalID > &ownerIds_)
 検索するアップロードした人の プリンシパル ID をセットします。 [詳解]
 
void SetOwnerType (DataStoreConstants::SearchTarget ownerType_)
 検索するアップロードした人の プリンシパル ID のタイプをセットします。 [詳解]
 
void SetResultOption (qUnsignedInt32 resultOption_)
 検索の戻り値オプションをセットします。 [詳解]
 
void SetResultRange (const ResultRange &resultRange_)
 検索範囲をセットします。 [詳解]
 
void SetSearchSortOrder (DataStoreConstants::SearchSortOrder resultOrder_)
 検索結果のソート順をセットします。 [詳解]
 
void SetSearchSortOrderColumn (DataStoreConstants::SearchSortColumn resultOrderColumn_)
 検索結果のソート対象とするカラムをセットします。 [詳解]
 
void SetSearchType (DataStoreConstants::SearchType searchType)
 検索タイプをセットします。 [詳解]
 
void SetTags (const qVector< String > &tags_)
 検索するタグをセットします。 [詳解]
 
void SetTotalCountEnabled (const qBool totalCountEnabled_)
 検索条件に一致した総数を取得するかどうかをセットします。 [詳解]
 
void SetUpdatedAfter (const DateTime &updatedAfter_)
 検索する更新日時の開始点をセットします。 [詳解]
 
void SetUpdatedBefore (const DateTime &updatedBefore_)
 検索する更新日時の終了点をセットします。 [詳解]
 
void SetUseCache (const qBool useCache_)
 検索結果のキャッシュを使用するかどうかをセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 DataStoreChangeMetaParamオブジェクトの内容をトレースします。 [詳解]
 

詳解

メタ情報の検索に関するパラメータを表すクラスです。

関数詳解

void nn::nex::DataStoreSearchParam::SetSearchType ( DataStoreConstants::SearchType  searchType)

検索タイプをセットします。

デフォルトは DataStoreConstants::SEARCH_TYPE_PUBLIC です。 本関数を使用した場合の動作の詳細についてプログラミングマニュアルを参照してください。

引数
[in]searchType検索タイプ。
DataStoreConstants::SearchType nn::nex::DataStoreSearchParam::GetSearchType ( ) const

検索タイプを取得します。

戻り値
検索タイプ。
void nn::nex::DataStoreSearchParam::SetOwnerIds ( const qVector< PrincipalID > &  ownerIds_)

検索するアップロードした人の プリンシパル ID をセットします。

指定しなかった場合はこの条件が検索条件から除外されます。

引数
[in]ownerIds_検索するアップロードした人の プリンシパル ID のリスト。
const qVector<PrincipalID>& nn::nex::DataStoreSearchParam::GetOwnerIds ( ) const

検索するアップロードした人の プリンシパル ID を取得します。

戻り値
検索するアップロードした人の プリンシパル ID のリスト。
void nn::nex::DataStoreSearchParam::SetOwnerType ( DataStoreConstants::SearchTarget  ownerType_)

検索するアップロードした人の プリンシパル ID のタイプをセットします。

引数
[in]ownerType_検索するアップロードした人の プリンシパル ID のタイプ。
DataStoreConstants::SearchTarget nn::nex::DataStoreSearchParam::GetOwnerType ( ) const

検索するアップロードした人の プリンシパル ID のタイプを取得します。

戻り値
検索するアップロードした人の プリンシパル ID のタイプ。
void nn::nex::DataStoreSearchParam::SetDestinationIds ( const qVector< PrincipalID > &  destinationIds_)

検索する参照権限保持者の プリンシパル ID をセットします。

データアップロード時に参照権限をセットする際に DataStorePermission::DataStorePermission() の第二引数で権限保持者の プリンシパル ID を指定できますが、 本関数を使用するとその権限保持者の プリンシパル ID を指定してデータを検索することができます。 指定しなかった場合はこの条件が検索条件から除外されます。 検索タイプが DataStoreConstants::SEARCH_TYPE_PUBLIC もしくは DataStoreConstants::SEARCH_TYPE_FRIEND の場合に指定できます。 自分自身が参照権限に含まれているものを検索する場合は検索タイプを DataStoreConstants::SEARCH_TYPE_RECEIVED とするのが便利です。 DataStoreConstants::SEARCH_TYPE_RECEIVED を使用した場合は本関数で自分の プリンシパル ID を指定する必要はありません。 (自分の プリンシパル ID を指定してもエラーとはなりません。) 参照権限保持者を送信宛先と見立てて、特定の人が受け取ったデータを列挙するという使い方が可能です。

引数
[in]destinationIds_検索する、参照権限として指定された プリンシパル ID のリスト。複数の プリンシパル ID が指定されたときは OR で検索されます。
const qVector<PrincipalID>& nn::nex::DataStoreSearchParam::GetDestinationIds ( ) const

検索する参照権限保持者の プリンシパル ID を取得します。

戻り値
検索する参照権限保持者の プリンシパル ID のリスト。
void nn::nex::DataStoreSearchParam::SetDataType ( const qUnsignedInt16  dataType_)

検索するデータタイプ 1 つをセットします。

デフォルトでは検索条件にデータタイプを指定しません。

引数
[in]dataType_検索するデータタイプ。
void nn::nex::DataStoreSearchParam::SetDataType ( const qVector< qUnsignedInt16 > &  dataTypes_)

検索するデータタイプのリストをセットします。

デフォルトでは検索条件にデータタイプを指定しません。 最大 DataStoreConstants::MAX_SEARCH_DATA_TYPE_SIZE 個のデータタイプを指定できます。

引数
[in]dataTypes_検索するデータタイプのリスト。
qUnsignedInt16 nn::nex::DataStoreSearchParam::GetDataType ( ) const

検索するデータタイプを 1 つ取得します。

DataStoreSearchParam::SetDataType() で複数のデータタイプを指定している場合は、指定したデータタイプのリスト中の先頭のデータタイプが返ります。 検索条件にデータタイプを指定していない場合は、DataStoreConstants::INVALID_DATA_TYPE が返ります。

戻り値
検索するデータタイプ。
void nn::nex::DataStoreSearchParam::GetDataType ( qVector< qUnsignedInt16 > &  dataTypes_) const

検索するデータタイプのリストを取得します。

検索条件にデータタイプを指定していない場合は、空のリストが返ります。

引数
[out]dataTypes_検索するデータタイプのリスト。
void nn::nex::DataStoreSearchParam::SetCreatedAfter ( const DateTime createdAfter_)

検索するアップロードされた日時の開始点をセットします。

アップロードされた日時の開始点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

DataStoreSearchParam::SetCreatedAfter() で指定した日時以降、 DataStoreSearchParam::SetCreatedBefore() で指定した日時以前のものを検索します。 DataStoreConstants::INVALID_DATE_TIME を指定した場合はこの条件が検索条件から除外されます。デフォルトは DataStoreConstants::INVALID_DATE_TIME です。

引数
[in]createdAfter_検索するアップロードされた日時の開始点。
const DateTime& nn::nex::DataStoreSearchParam::GetCreatedAfter ( ) const

検索するアップロードされた日時の開始点を取得します。

アップロードされた日時の開始点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

戻り値
検索するアップロードされた日時の開始点。
void nn::nex::DataStoreSearchParam::SetCreatedBefore ( const DateTime createdBefore_)

検索するアップロードされた日時の終了点をセットします。

アップロードされた日時の終了点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

DataStoreSearchParam::SetCreatedAfter() で指定した日時以降、 DataStoreSearchParam::SetCreatedBefore() で指定した日時以前のものを検索します。 DataStoreConstants::INVALID_DATE_TIME を指定した場合はこの条件が検索条件から除外されます。デフォルトは DataStoreConstants::INVALID_DATE_TIME です。

引数
[in]createdBefore_検索するアップロードされた日時の終了点。
const DateTime& nn::nex::DataStoreSearchParam::GetCreatedBefore ( ) const

検索するアップロードされた日時の終了点を取得します。

アップロードされた日時の終了点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

戻り値
検索するアップロードされた日時の終了点。
void nn::nex::DataStoreSearchParam::SetUpdatedAfter ( const DateTime updatedAfter_)

検索する更新日時の開始点をセットします。

更新日時の開始点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

DataStoreSearchParam::SetUpdatedAfter() で指定した日時以降、 DataStoreSearchParam::SetUpdatedBefore() で指定した日時以前のものを検索します。 DataStoreConstants::INVALID_DATE_TIME を指定した場合はこの条件が検索条件から除外されます。デフォルトは DataStoreConstants::INVALID_DATE_TIME です。

引数
[in]updatedAfter_検索するアップロードされた日時の開始点。
const DateTime& nn::nex::DataStoreSearchParam::GetUpdatedAfter ( ) const

検索する更新日時の開始点を取得します。

更新日時の開始点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

戻り値
検索する更新日時の開始点。
void nn::nex::DataStoreSearchParam::SetUpdatedBefore ( const DateTime updatedBefore_)

検索する更新日時の終了点をセットします。

更新日時の終了点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

DataStoreSearchParam::SetUpdatedAfter() で指定した日時以降、 DataStoreSearchParam::SetUpdatedBefore() で指定した日時以前のものを検索します。 DataStoreConstants::INVALID_DATE_TIME を指定した場合はこの条件が検索条件から除外されます。デフォルトは DataStoreConstants::INVALID_DATE_TIME です。

引数
[in]updatedBefore_検索するアップロードされた日時の終了点。
const DateTime& nn::nex::DataStoreSearchParam::GetUpdatedBefore ( ) const

検索する更新日時の終了点を取得します。

更新日時の終了点は検索のパラメータから将来的に廃止予定であるため、本関数の使用は推奨されません。

戻り値
検索する更新日時の終了点。
void nn::nex::DataStoreSearchParam::SetSearchSortOrderColumn ( DataStoreConstants::SearchSortColumn  resultOrderColumn_)

検索結果のソート対象とするカラムをセットします。

デフォルトは DataStoreConstants::SEARCH_SORT_COLUMN_DATAID です。

ソート対象に DataStoreConstants::SEARCH_SORT_COLUMN_DATAID 以外のカラムをセットする場合は、 DataStoreSearchParam::SetDataType() で検索対象のデータタイプを 1 つセットする必要があります。 DataStoreConstants::SEARCH_SORT_COLUMN_DATAID 以外のカラムでソートする際は、複数のデータタイプを指定することはできません。

引数
[in]resultOrderColumn_検索結果のソート対象とするカラム。
DataStoreConstants::SearchSortColumn nn::nex::DataStoreSearchParam::GetSearchSortOrderColumn ( ) const

検索結果のソート対象とするカラムを取得します。

戻り値
検索結果のソート対象とするカラム。
void nn::nex::DataStoreSearchParam::SetSearchSortOrder ( DataStoreConstants::SearchSortOrder  resultOrder_)

検索結果のソート順をセットします。

デフォルトは DataStoreConstants::SEARCH_SORT_ORDER_ASC です。

引数
[in]resultOrder_検索結果のソート順。
DataStoreConstants::SearchSortOrder nn::nex::DataStoreSearchParam::GetSearchSortOrder ( ) const

検索結果のソート順を取得します。

戻り値
検索結果のソート順。
void nn::nex::DataStoreSearchParam::SetResultRange ( const ResultRange resultRange_)

検索範囲をセットします。

デフォルトは ResultRange() です。 本関数で検索結果の取得数を設定する際、指定可能な最大数は DataStoreConstants::MAX_SEARCH_RESULT_SIZE です。

RESULTRANGE_ANY_OFFSET を設定すると、検索結果は、ソート対象とソート順をもとにした擬似的に無作為な順序になります。なお、この時指定可能な最大数は DataStoreConstants::MAX_SEARCH_ANY_RESULT_SIZE です。

引数
[in]resultRange_検索範囲。
const ResultRange& nn::nex::DataStoreSearchParam::GetResultRange ( ) const

検索範囲を取得します。

戻り値
検索範囲。
void nn::nex::DataStoreSearchParam::SetResultOption ( qUnsignedInt32  resultOption_)

検索の戻り値オプションをセットします。

DataStoreConstants::ResultFlag に対してビット単位の論理和を用いて複数指定することができます。 指定したオプションの情報を検索結果で取得できる情報に加えることができます。 デフォルトは 0 です。

引数
[in]resultOption_検索の戻り値オプション値。
qByte nn::nex::DataStoreSearchParam::GetResultOption ( ) const

検索の戻り値オプションを取得します。

戻り値
検索の戻り値オプション値。
void nn::nex::DataStoreSearchParam::SetTags ( const qVector< String > &  tags_)

検索するタグをセットします。

デフォルトは qVector<String>() です。指定した全てのタグと一致するものを検索します。 最大 DataStoreConstants::NUM_TAG_SLOT 個のタグを指定できます。空文字列のタグは指定できません。

タグを指定する際は DataStoreSearchParam::SetDataType() で検索対象のデータタイプを 1 つセットする必要があります。 タグ指定時に複数のデータタイプを指定することはできません。

DataStoreClient::SearchObjectLight() を使用する場合はタグをセットすることはできません。

引数
[in]tags_検索するタグ。
const qVector<String>& nn::nex::DataStoreSearchParam::GetTags ( ) const

検索するタグを取得します。

戻り値
検索するタグ。
void nn::nex::DataStoreSearchParam::SetMinimalRatingFrequency ( const qUnsignedInt32  minimalRatingFrequency_)

最低評価回数をセットします。

このパラメータは、ソート順に評価値もしくは評価平均値を指定した場合のみ有効です。

引数
[in]minimalRatingFrequency_最低評価回数
qUnsignedInt32 nn::nex::DataStoreSearchParam::GetMinimalRatingFrequency ( )

最低評価回数を取得します。

戻り値
最低評価回数
void nn::nex::DataStoreSearchParam::SetUseCache ( const qBool  useCache_)

検索結果のキャッシュを使用するかどうかをセットします。

検索結果のキャッシュを使用する場合は、 DataStoreSearchParam::SetSearchType() で検索タイプに DataStoreConstants::SEARCH_TYPE_PUBLIC を、 DataStoreSearchParam::SetOwnerType() でアップロードした人のプリンシパル ID のタイプに DataStoreConstants::SEARCH_TARGET_ANYBODY を セットする必要があります。

引数
[in]useCache_検索結果のキャッシュを使用するかどうか
qBool nn::nex::DataStoreSearchParam::GetUseCache ( )

検索結果のキャッシュを使用するかどうかを取得します。

デフォルトはfalseです。 trueが指定された場合は、検索結果のキャッシュが存在すればキャッシュから応答を生成します。

戻り値
検索結果のキャッシュを使用するかどうか
void nn::nex::DataStoreSearchParam::SetTotalCountEnabled ( const qBool  totalCountEnabled_)

検索条件に一致した総数を取得するかどうかをセットします。

DataStoreClient::SearchObjectLight() を使用する場合は検索条件に一致した総数を取得することはできません。

引数
[in]totalCountEnabled_検索条件に一致した総数を取得するか
qBool nn::nex::DataStoreSearchParam::GetTotalCountEnabled ( )

検索条件に一致した総数を取得するかどうかを取得します。

デフォルトはfalseです。 false の場合は、検索条件に一致した総数は常に0になります。(検索にヒットしたデータそのものは検索結果に含まれます) true の場合は、検索条件に一致した総数が検索結果に反映されます。

戻り値
検索条件に一致した総数を取得するかどうか
void nn::nex::DataStoreSearchParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

DataStoreChangeMetaParamオブジェクトの内容をトレースします。

引数
[in]uiTraceFlagsTraceLog::SetFlag()の引数と同様です。