com.nec.baas.object

インタフェース NbOfflineObjectBucket

既知のサブインタフェースのリスト:

NbObjectBucket

public interface NbOfflineObjectBucket

オフラインオブジェクトバケット

導入されたバージョン:

1.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.util.Map<java.lang.String,NbIndexType>	getIndexFromLocal() ローカルDBにインデックスされているキーの一覧を取得する。
NbQuery	getSyncScope() オフライン: 同期範囲の取得を行う。
void	registerSyncEventListener(NbObjectSyncEventListener listener) オフライン: 同期処理の進捗イベントを受け取るリスナーを設定する。
void	removeCache() オフライン用データベースに保存されたバケットとバケットに保存されたオブジェクトの情報を削除する。
void	removeSyncScope() オフライン: 同期範囲の削除を行う。
void	setIndexToLocal(java.util.Map<java.lang.String,NbIndexType> indexKeys, NbResultCallback callback) ローカルDB用のインデックスを設定する。
void	setSyncScope(NbQuery scope) オフライン: 同期範囲の指定を行う。
void	sync(NbResultCallback callback) バケットの同期を行う。
void	unregisterSyncEventListener(NbObjectSyncEventListener listener) オフライン: 同期処理の進捗イベントを受け取るリスナーを解除する。

メソッドの詳細

sync

void sync(NbResultCallback callback)

バケットの同期を行う。

本メソッドはレプリカモードのみ有効。
同期条件が未設定の場合、処理に失敗する。
同期ではバケット情報とバケットに保存されたオブジェクトをサーバから取得後、オフライン用データベースのデータを更新する。
処理の進捗はSyncEventListenerで通知する。

関連項目:

setSyncScope(NbQuery), NbObjectSyncEventListener

removeCache

void removeCache()

オフライン用データベースに保存されたバケットとバケットに保存されたオブジェクトの情報を削除する。
本メソッドはレプリカ・ローカルモードで有効。

setSyncScope

void setSyncScope(NbQuery scope)

オフライン: 同期範囲の指定を行う。 scopeにquery条件を設定する。 同期範囲のsortOrder、limit、skipCount、deleteMarkは無効とする 範囲条件が無い場合は、空のNbQueryインスタンスを設定すること。

パラメータ:

scope - 同期範囲

getSyncScope

NbQuery getSyncScope()

オフライン: 同期範囲の取得を行う。

戻り値:

同期範囲

removeSyncScope

void removeSyncScope()

オフライン: 同期範囲の削除を行う。

registerSyncEventListener

void registerSyncEventListener(NbObjectSyncEventListener listener)

オフライン: 同期処理の進捗イベントを受け取るリスナーを設定する。

パラメータ:

listener - 同期処理の進捗イベントを受け取るリスナー

関連項目:

NbObjectSyncEventListener

unregisterSyncEventListener

void unregisterSyncEventListener(NbObjectSyncEventListener listener)

オフライン: 同期処理の進捗イベントを受け取るリスナーを解除する。

パラメータ:

listener - 解除するリスナーのインスタンス

関連項目:

NbObjectSyncEventListener

setIndexToLocal

void setIndexToLocal(java.util.Map<java.lang.String,NbIndexType> indexKeys,
                     NbResultCallback callback)

ローカルDB用のインデックスを設定する。

• インデックスに使用するフィールドは、トップレベルのフィールドのみ指定できる。
• インデックスに使用するフィールドに設定するデータは、スカラ値のみサポートする。

パラメータ:

indexKeys - インデックス設定したいフィールド名の一覧

callback - インデックス設定結果を取得するコールバック

導入されたバージョン:

1.2.2

getIndexFromLocal

java.util.Map<java.lang.String,NbIndexType> getIndexFromLocal()

ローカルDBにインデックスされているキーの一覧を取得する。

戻り値:

ローカルDBにインデックスされているキーの一覧

導入されたバージョン:

1.2.2