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

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

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

DDLCLASSDataStoreChangeMetaParamを継承しています。

公開メンバ関数

 DataStoreChangeMetaParam ()
 コンストラクタです。
 
virtual ~DataStoreChangeMetaParam ()
 デストラクタです。
 
const DataStorePermissionGetAccessPermission () const
 参照権限を取得します。 [詳解]
 
const DataStoreChangeMetaCompareParamGetChangeMetaCompareParam () const
 コンペアアンドスワップで使用する、比較用期待値を取得します。 [詳解]
 
qUnsignedInt64 GetDataId () const
 データIDを取得します。 [詳解]
 
DataStoreConstants::DataStatus GetDataStatus () const
 ステータスを取得します。 [詳解]
 
qUnsignedInt16 GetDataType () const
 データタイプを取得します。 [詳解]
 
const DataStorePermissionGetDeletePermission () const
 更新権限を取得します。推奨されません。 [詳解]
 
qVector< qByteGetMetaBinary () const
 メタ情報内バイナリデータを取得します。 [詳解]
 
void GetMetaBinary (qVector< qByte > &metaBinary_) const
 メタ情報内バイナリデータを取得します。 [詳解]
 
qUnsignedInt32 GetModificationFlag () const
 変更フラグを取得します。 [詳解]
 
const StringGetName () const
 タイトルを取得します。 [詳解]
 
qUnsignedInt16 GetPeriod () const
 有効日数を取得します。 [詳解]
 
const DataStorePersistenceTargetGetPersistenceTarget () const
 変更するデータの永続化対象を取得します。 [詳解]
 
qUnsignedInt32 GetReferredCount () const
 ダウンロードされた回数を取得します。廃止されるため使用できません。 [詳解]
 
const qVector< String > & GetTags () const
 タグを取得します。 [詳解]
 
qUnsignedInt64 GetUpdatePassword () const
 更新パスワードを取得します。 [詳解]
 
const DataStorePermissionGetUpdatePermission () const
 更新権限を取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetAccessPermission (const DataStorePermission &permission_)
 参照権限をセットします。 [詳解]
 
void SetChangeMetaCompareParam (const DataStoreChangeMetaCompareParam &compareParam_)
 コンペアアンドスワップで変更するよう、比較用期待値を設定します。 [詳解]
 
void SetDataId (qUnsignedInt64 dataId_)
 データIDをセットします。 [詳解]
 
void SetDataStatus (DataStoreConstants::DataStatus status_)
 ステータスを設定します。 [詳解]
 
void SetDataType (qUnsignedInt16 dataType_)
 データタイプを設定します。 [詳解]
 
void SetDeletePermission (const DataStorePermission &delPermission_)
 更新権限をセットします。推奨されません。 [詳解]
 
void SetMetaBinary (const void *p, size_t size)
 メタ情報内バイナリデータをセットします。 [詳解]
 
void SetModificationFlag (qUnsignedInt32 modificationFlag)
 変更フラグをセットします。 [詳解]
 
void SetName (const String &name_)
 タイトルをセットします [詳解]
 
void SetPeriod (qUnsignedInt16 period_)
 有効日数をセットします。 [詳解]
 
void SetPersistenceTarget (DataStorePersistenceTarget persistenceTarget_)
 変更するデータを永続化対象(プリンシパルIDと永続化スロットID)で指定します。 [詳解]
 
void SetReferredCount (qUnsignedInt32 referredCount)
 ダウンロードされた回数を設定します。廃止されるため使用できません。 [詳解]
 
void SetTags (const qVector< String > &tags_)
 タグをセットします [詳解]
 
void SetUpdatePassword (qUnsignedInt64 updatePassword_)
 更新パスワードを設定します。 [詳解]
 
void SetUpdatePermission (const DataStorePermission &updatePermission)
 更新権限をセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 DataStoreChangeMetaParamオブジェクトの内容をトレースします。 [詳解]
 

詳解

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

関数詳解

void nn::nex::DataStoreChangeMetaParam::SetDataId ( qUnsignedInt64  dataId_)

データIDをセットします。

メタデータを変更するデータのデータIDを指定します。 本パラメータを設定する場合は DataStoreChangeMetaParam::SetPersistenceTarget() で永続化対象(プリンシパルIDと永続化スロットID)を設定しないでください。

引数
[in]dataId_メタデータを変更するデータのデータID。
qUnsignedInt64 nn::nex::DataStoreChangeMetaParam::GetDataId ( ) const

データIDを取得します。

戻り値
データID。
void nn::nex::DataStoreChangeMetaParam::SetModificationFlag ( qUnsignedInt32  modificationFlag)

変更フラグをセットします。

メタデータを変更する箇所を表すフラグを指定します。本パラメータは必ず指定する必要があります。 DataStoreConstants::ModificationFlag に対してビット単位の論理和を用いて複数指定することができます。

引数
[in]modificationFlagメタデータを変更する箇所を表すビットフラグ。 DataStoreConstants::ModificationFlag に対するビット単位の論理和です。
qUnsignedInt32 nn::nex::DataStoreChangeMetaParam::GetModificationFlag ( ) const

変更フラグを取得します。

戻り値
メタデータを変更する箇所を表すビットフラグ。 DataStoreConstants::ModificationFlag に対するビット単位の論理和です。
void nn::nex::DataStoreChangeMetaParam::SetName ( const String name_)

タイトルをセットします

新しいタイトル(要約情報)を指定します。本パラメータの指定は必須ではありません。デフォルトは空文字列です。

引数
[in]name_新しいタイトル(要約情報)。
const String& nn::nex::DataStoreChangeMetaParam::GetName ( ) const

タイトルを取得します。

戻り値
タイトル。
void nn::nex::DataStoreChangeMetaParam::SetAccessPermission ( const DataStorePermission permission_)

参照権限をセットします。

新しい参照権限を指定します。本パラメータの指定は必須ではありません。デフォルトは DataStorePermission(DataStoreConstants::PERMISSION_PRIVATE) です。

引数
[in]permission_新しい参照権限。
const DataStorePermission& nn::nex::DataStoreChangeMetaParam::GetAccessPermission ( ) const

参照権限を取得します。

戻り値
参照権限。
void nn::nex::DataStoreChangeMetaParam::SetDeletePermission ( const DataStorePermission delPermission_)

更新権限をセットします。推奨されません。

これは互換性のために残されている古い関数です。 DataStoreChangeMetaParam::SetUpdatePermission() を使用して下さい。 新しい更新権限を指定します。本パラメータの指定は必須ではありません。デフォルトは DataStorePermission(DataStoreConstants::PERMISSION_PRIVATE) です。

引数
[in]delPermission_新しい更新権限。
const DataStorePermission& nn::nex::DataStoreChangeMetaParam::GetDeletePermission ( ) const

更新権限を取得します。推奨されません。

これは互換性のために残されている古い関数です。 DataStoreChangeMetaParam::GetUpdatePermission() を使用して下さい。

戻り値
更新権限。
void nn::nex::DataStoreChangeMetaParam::SetUpdatePermission ( const DataStorePermission updatePermission)

更新権限をセットします。

新しい更新権限を指定します。本パラメータの指定は必須ではありません。デフォルトは DataStorePermission(DataStoreConstants::PERMISSION_PRIVATE) です。

引数
[in]updatePermission新しい更新権限。
const DataStorePermission& nn::nex::DataStoreChangeMetaParam::GetUpdatePermission ( ) const

更新権限を取得します。

戻り値
更新権限。
void nn::nex::DataStoreChangeMetaParam::SetPeriod ( qUnsignedInt16  period_)

有効日数をセットします。

新しい有効日数を指定します。本パラメータの指定は必須ではありません。デフォルトは DataStoreConstants::DEFAULT_PERIOD です。

引数
[in]period_新しい有効日数。
qUnsignedInt16 nn::nex::DataStoreChangeMetaParam::GetPeriod ( ) const

有効日数を取得します。

戻り値
有効日数。
void nn::nex::DataStoreChangeMetaParam::SetTags ( const qVector< String > &  tags_)

タグをセットします

アップロードするデータにメタ情報として付加するタグを指定します。空文字列のタグは指定できません。 既にタグが設定されてる場合は、既存のタグは削除され、本関数で指定したタグで上書きされます。 本パラメータの指定は必須ではありません。デフォルトは空です。

引数
[in]tags_アップロードするデータにメタ情報として付加するタグ。
const qVector<String>& nn::nex::DataStoreChangeMetaParam::GetTags ( ) const

タグを取得します。

戻り値
タグ。
void nn::nex::DataStoreChangeMetaParam::SetMetaBinary ( const void *  p,
size_t  size 
)

メタ情報内バイナリデータをセットします。

アップロードするデータにメタ情報として付加するバイナリデータを指定します。 0-1024byteまで設定できます。本パラメータの指定は必須ではありません。デフォルトは空です。

引数
[in]pアップロードするデータにメタ情報として付加するバイナリデータのポインタ。NULLを指定すると空になります。
[in]sizeアップロードするバイナリデータのデータサイズ(0-1024)。
qVector<qByte> nn::nex::DataStoreChangeMetaParam::GetMetaBinary ( ) const

メタ情報内バイナリデータを取得します。

戻り値
メタ情報内バイナリデータ
void nn::nex::DataStoreChangeMetaParam::GetMetaBinary ( qVector< qByte > &  metaBinary_) const

メタ情報内バイナリデータを取得します。

こちらのオーバーロード関数の方が効率的です。

引数
[out]metaBinary_メタ情報内バイナリデータ。
void nn::nex::DataStoreChangeMetaParam::SetUpdatePassword ( qUnsignedInt64  updatePassword_)

更新パスワードを設定します。

更新権限を持たないデータを操作する場合に更新パスワードを指定します。 データのオーナーから受け取った更新パスワードを指定してください。 更新権限を持っている場合は更新パスワードは無視され、常に操作可能です。 DataStoreConstants::INVALID_PASSWORD を指定した場合は更新パスワードでの認証を行いません。 本関数で指定しない場合は DataStoreConstants::INVALID_PASSWORD が使用されます。

引数
[in]updatePassword_更新パスワード
qUnsignedInt64 nn::nex::DataStoreChangeMetaParam::GetUpdatePassword ( ) const

更新パスワードを取得します。

戻り値
更新パスワード。
void nn::nex::DataStoreChangeMetaParam::SetDataType ( qUnsignedInt16  dataType_)

データタイプを設定します。

引数
[in]dataType_データタイプ。
qUnsignedInt16 nn::nex::DataStoreChangeMetaParam::GetDataType ( ) const

データタイプを取得します。

戻り値
データタイプ。
void nn::nex::DataStoreChangeMetaParam::SetDataStatus ( DataStoreConstants::DataStatus  status_)

ステータスを設定します。

引数
[in]status_ステータス。
DataStoreConstants::DataStatus nn::nex::DataStoreChangeMetaParam::GetDataStatus ( ) const

ステータスを取得します。

戻り値
ステータス。
void nn::nex::DataStoreChangeMetaParam::SetReferredCount ( qUnsignedInt32  referredCount)

ダウンロードされた回数を設定します。廃止されるため使用できません。

引数
[in]referredCountダウンロードされた回数。
qUnsignedInt32 nn::nex::DataStoreChangeMetaParam::GetReferredCount ( ) const

ダウンロードされた回数を取得します。廃止されるため使用できません。

戻り値
ダウンロードされた回数。
void nn::nex::DataStoreChangeMetaParam::SetChangeMetaCompareParam ( const DataStoreChangeMetaCompareParam compareParam_)

コンペアアンドスワップで変更するよう、比較用期待値を設定します。

引数
[in]compareParam_比較用期待値

コンペアアンドスワップで変更する場合、変更前に、設定した期待値とデータの値を比較します。 この時、期待値とデータの値が等しい場合はメタ情報が変更され、異なる場合は変更されません。 本パラメータの指定は必須ではありません。デフォルトでは、コンペアアンドスワップを使用しない設定がされています。

const DataStoreChangeMetaCompareParam& nn::nex::DataStoreChangeMetaParam::GetChangeMetaCompareParam ( ) const

コンペアアンドスワップで使用する、比較用期待値を取得します。

戻り値
比較用期待値
void nn::nex::DataStoreChangeMetaParam::SetPersistenceTarget ( DataStorePersistenceTarget  persistenceTarget_)

変更するデータを永続化対象(プリンシパルIDと永続化スロットID)で指定します。

変更するデータをプリンシパルIDと永続化スロットIDで指定します。 本パラメータを設定する場合は DataStoreChangeMetaParam::SetDataId() でデータIDを設定しないでください。

引数
[in]persistenceTarget_変更するデータの永続化対象。
const DataStorePersistenceTarget& nn::nex::DataStoreChangeMetaParam::GetPersistenceTarget ( ) const

変更するデータの永続化対象を取得します。

戻り値
変更するデータの永続化対象。
void nn::nex::DataStoreChangeMetaParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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