パッケージ | mx.data |
クラス | public class DataManager |
継承 | DataManager Object |
実装 | IEventDispatcher |
サブクラス | DataService, RPCDataManager |
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager クラスは抽象クラスです。通常は DataManager を拡張する DataService インスタンスを構築するか、1 つまたは複数の RPCDataManager インスタンスを RPC サービスコンポーネント(HTTPMultiService、WebService、RemoteObject インスタンスなど)と併せて構築します。
Single Managed Object(SMO)を取得するには、DataManager.getItem()
メソッドおよび DataManager.createItem()
メソッドを使用します。
内容設定済みの ArrayCollection が不要になったとき、またはそのコレクション内のアイテムに対する更新の受信および作成が不要になったときは、DataManager.releaseCollection()
メソッドを呼び出します。
DataManager.getItem()
または DataManager.createItem()
を使用して前に取得したアイテムが不要になった場合、または更新を受信または作成しない場合、DataManager.releaseItem()
メソッドを呼び出します。DataManager.createItem()
メソッドと DataManager.getItem()
メソッドは ItemReference インスタンスを返します。ItemReference は Single Managed Object(SMO)の特定のインスタンスを解放するときに使用します。DataManager.releaseItem()
メソッドとは異なり、ItemReference.releaseItem()
メソッドを呼び出すと Single Managed Object(SMO)の特定のインスタンスが解放されます。DataManager.releaseItem()
メソッドは、指定した ID と一致する ID で検出された最初の Single Managed Object(SMO)を解放します。これは、DataManager.getItem()
メソッドおよび DataManager.createItem()
メソッドの呼び出しの数が DataManager.releaseItem()
メソッドの呼び出しの数と一致している限り問題ありません。
接続を必要とするメソッドが初めて呼び出されると、リモート宛先への接続が自動的に作成されます。例えば、未コミットの更新があるときに DataManager.fill()
メソッドまたは DataManager.commit()
メソッドを呼び出すと、DataManager インスタンスはリモート宛先への接続を確立しようとします。DataManager インスタンスの接続を強制的に解除するには、DataManager.disconnect()
メソッドを呼び出します。不要になったリモート宛先リソースをクリーンアップするには、DataManager.disconnect()
メソッドを使用できます。他のサービスで同じ物理接続が使用されている可能性があるため、DataManager.disconnect()
メソッドを呼び出すと接続が終了する場合があります。
バインド可能なプロパティ connected
は、関連付けられている DataManager 接続の現在の状態を示します。
各 DataManager インスタンスには mx.data.DataStore
型のオブジェクトを返す dataStore
プロパティがあります。このオブジェクトには、1 つ以上の DataManager インスタンスに関する未コミットの変更が格納されています。デフォルトでは、DataManager インスタンスは、管理対象の関連付けプロパティを持ち、同じチャネルセットを共有している他のデータサービスと同じ DataManager を共有します。DataStore インスタンスを共有しているときに、1 つの DataManager インスタンス上で commit()
メソッドを呼び出すと、共有 DataStore インスタンスを使用しているすべての DataManager インスタンスが変更されます。関連付けられている DataManager インスタンスに加えられた変更の間に依存関係がある場合、操作の順序は維持されます。
DataManager と DataStore は、リモート呼び出しを必要とするすべての操作の結果およびフォルトイベントを送出します。メモ:同じ宛先をポイントする 2 つの DataManager インスタンスを作成した場合、これらのインスタンスは同じ管理対象オブジェクトのコレクションを共有し、同じイベントを送出します。例えば、1 つの DataManager インスタンスに宛先としてイベントリスナーを追加し、別のインスタンスを使用して操作を開始した場合、最初の DataManager インスタンスは引き続きそれらのイベントを受け取ります。DataManager に対して操作を開始するたびに、AsyncToken が返されます。そのトークンにイベントの応答側を追加すると、その操作に固有の結果イベントを受信できます。一般に、この方法を使用すると、特定の宛先に対して結果またはフォルトイベントハンドラーをグローバルに追加するよりもコードが簡潔になります。
DataManager インスタンスの管理対象オブジェクトのすべてのプロパティでデータバインディングを使用できます。管理対象オブジェクトに対してリモート操作が発生すると、DataManager インスタンスは「メッセージ」イベントも送出します。例えば、リモートプロセスでローカルで管理されているアイテムを更新すると、そのアイテムを管理しているすべての DataManager インスタンスに対してメッセージがプッシュされます。このメッセージは、MessageEvent.MESSAGE
イベントとして送出されます。
リモート宛先で DataManager インスタンスがコミットする変更に対する応答として、またはローカルの未コミットの変更と競合するプッシュされた変更によって、競合イベントは送出されます。DataConflictEvent.CONFLICT
をリスニングすることで競合イベントを処理できます。DataManager.conflicts.resolved
プロパティにバインディングすることで、データバインディングを使用してユーザーインターフェイスコントロールを更新します。
DataManager クラスは、次のデータ同期設定モードをサポートしています。
-
autoCommit
- true の場合、変更が検出されるたびに、各変更が直ちにリモート宛先へ送信されます。これがfalse
の場合、commit()
メソッドを明示的に呼び出す必要があります。未コミットの変更があるかどうかを判断するには、バインド可能なDataManager.commitRequired
プロパティを使用します。 -
autoSyncEnabled
- これはfill()
、getItem()
、createItem()
の各メソッドの呼び出しに適用され、他のクライアントによってこれらのオブジェクトに加えられた変更、またはリモート宛先で DataServiceTransaction サーバープッシュ API を使用して加えられた変更を、管理対象インスタンスでリスニングするかどうかを決定します。 -
autoMerge
プロパティ - リモート宛先から受信した変更を直ちに適用するか、DataManager.merge()
メソッドの呼び出しが行われるまで待機するかを制御します。
特定のアイテムまたはすべてのアイテムに対する変更を元に戻すには、DataManager.revertChanges()
メソッドを使用します。リモート宛先の操作でエラーが発生すると、リモート宛先のデータとの同期を維持するために、コミット済みの変更が未コミットのキューに戻されます。変更がエラーになった場合、通常は、フォルトハンドラーの一部として DataManager.revertChanges()
メソッドを呼び出して変更を取り消します。
関連する API エレメント
mx.data.RPCDataManager
mx.data.Conflicts
mx.data.Conflict
mx.data.ItemReference
mx.data.IManaged
mx.data.utils.Managed
mx.data.IChangeObject
プロパティ | 定義元 | ||
---|---|---|---|
adapter : DataServiceAdapter = null
サーバーとの対話を制御するクラスのインスタンスです。 | DataManager | ||
autoCommit : Boolean
ローカルキャッシュに対する変更を自動的にコミットするかどうかを示します。 | DataManager | ||
autoConnect : Boolean
接続を必要とする操作を処理する場合に、このサービスで接続を試みる必要があるかどうかを示します。 | DataManager | ||
autoMerge : Boolean
false に設定した場合、リモート宛先からクライアントにプッシュされた変更は、直ちには適用されません。 | DataManager | ||
autoSaveCache : Boolean
データのローカルキャッシュと変更をディスクに格納できます。 | DataManager | ||
autoSyncEnabled : Boolean
これを true に設定して、fill()、createItem()、または getItem() 要求を発行すると、リモート宛先からこれらのアイテムに加えられた更新をリスニングするアイテムが返されます。 | DataManager | ||
cacheID : String
このサービスのキャッシュ識別子へのアクセスを提供します。 | DataManager | ||
commitRequired : Boolean [読み取り専用]
未コミットの変更があり、commit() メソッドを呼び出す必要があるかどうかを示します。 | DataManager | ||
conflictDetector : ConflictDetector
この DataManager インスタンスにプッシュされたリモート操作に関する競合を検出するために使用されている現在の実装へのアクセスを提供します。 | DataManager | ||
conflicts : Conflicts [読み取り専用]
Conflicts オブジェクト(Conflict インスタンスの ArrayList)を格納します。 | DataManager | ||
connected : Boolean [読み取り専用]
DataService がリモート宛先に接続されているかどうかを示します。 | DataManager | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
dataStore : DataStore
mx.data.DataStore 型のオブジェクトを含みます。 | DataManager | ||
deleteItemOnRemoveFromFill : Boolean
デフォルトでは、既に内容が設定された管理対象のコレクションに対して removeItemAt() メソッドを呼び出すと、サーバーに対してアイテム削除要求が発行され、アイテムが物理的に削除されます。 | DataManager | ||
encryptLocalCache : Boolean
SQL オフラインアダプターを使用する AIR クライアントに対して、オフラインストレージを暗号化するかどうかを示します。 | DataManager | ||
fallBackToLocalFill : Boolean
このフラグによって、アプリケーションに接続していない場合はアプリケーションがローカルストアに対してクエリするかどうかを決定します。 | DataManager | ||
hierarchicalEventsDefault : Boolean
関連付けでは、オプションで、関連付けられているインスタンスのプロパティに対するプロパティ変更イベントがリストされます。 | DataManager | ||
ignoreCollectionUpdates : Boolean
コミット時にサーバーに対して通信する代わりに、管理対象コレクションに対する変更を無視するかどうかを示します。 | DataManager | ||
indexReferences : Boolean
他のアイテムの関連付けプロパティからこの DataManager によって管理されるアイテムへの参照または fill の数が少ない場合は、このプロパティを false に設定することで、アプリケーションの速度を改善できます。 | DataManager | ||
isInitialized : Boolean [読み取り専用]
この DataManager インスタンスと関連付けられているメタデータを初期化するかどうかを示します。 | DataManager | ||
manualSync : ManualSyncConfiguration
DataManager インスタンスごとに ManualSyncConfiguration インスタンスへのアクセスを提供します。 | DataManager | ||
maxFrequency : uint
DataManager インスタンスが 1 秒間に受信できるメッセージの最大数を指定します。 | DataManager | ||
mergeRequired : Boolean [読み取り専用]
マージが必要な保留状態の変更があるかどうかを示します。 | DataManager | ||
offlineAdapter : DataServiceOfflineAdapter
mx.data.DataServiceOfflineAdapter 型のオブジェクトを返します。 | DataManager | ||
pageSize : int
すべてのコレクションに関する現在のページサイズ設定へのアクセスを提供します。 | DataManager | ||
pagingEnabled : Boolean [読み取り専用]
ページングされた要求を許可するようにリモート宛先が設定されているかどうかを示します。 | DataManager | ||
priority : int
DataManager インスタンスが送信するメッセージのデフォルトのメッセージ優先度です。 | DataManager | ||
requestTimeout : int
操作の要求タイムアウト(秒単位)へのアクセスを提供します。 | DataManager | ||
resetCollectionOnFill : Boolean
プロパティが true の場合は、fill 操作の完了後に RESET イベントが送信されます。 | DataManager | ||
resubscribeAttempts : int
接続を解除された DataManager インスタンスが、宛先に対して再サブスクライブを試行する回数を制御します。 | DataManager | ||
resubscribeInterval : int
再サブスクライブの試みの間の遅延を制御します(ミリ秒単位)。 | DataManager | ||
saveCacheRequired : Boolean [読み取り専用]
ローカルキャッシュに保存されていない変更があるので、saveCache() メソッドを呼び出す必要があるかどうかを示します。 | DataManager | ||
subscribed : Boolean [読み取り専用]
DataManager インスタンスがリモート宛先にサブスクライブされているかどうかを示します。 | DataManager | ||
throwItemPendingErrors : Boolean
取得に時間がかかるデータやページングされていないデータにアクセスしたときに ItemPending エラーがスローされないようにするには、このプロパティを false に設定します。 | DataManager |
メソッド | 定義元 | ||
---|---|---|---|
指定された宛先を持つ DataService のインスタンスを作成します。 | DataManager | ||
以前の saveCache() メソッドの呼び出しによってディスクに格納されたデータ、または autoSaveCache メソッドが true に設定されている間にディスクに格納されたデータを消去します。
| DataManager | ||
渡された記述子で指定されているデータをローカルストアから消去します。 | DataManager | ||
この DataManager インスタンスに関連付けられている DataStore インスタンスによって現在管理されているすべてのコレクションに対する保留中の変更をコミットします。 | DataManager | ||
このオブジェクトについて保留状態の変更があるかどうかを示します。 | DataManager | ||
このサービスからリモート宛先への接続を強制的に試みます。 | DataManager | ||
リモート宛先に対して count メソッドを呼び出します。 | DataManager | ||
指定したアイテムをリモートストア内に作成するように要求します。 | DataManager | ||
指定したアイテムをリモートストアから削除するように要求します。 | DataManager | ||
DataManager インスタンスのネットワーク接続を解除します。 | DataManager | ||
指定された名前と引数を使用してクエリを実行します。 | DataManager | ||
宛先に関連付けられた塗りつぶし方式に基づいて、指定された ListCollectionView(コレクション)インスタンスを塗りつぶします。 | DataManager | ||
宛先に関連付けられた塗りつぶし方式に基づいて、指定された ListCollectionView(コレクション)インスタンスを塗りつぶします。 | DataManager | ||
単一のアイテムを返すクエリを実行します。 | DataManager | ||
ArrayCollection または Single Managed Object(SMO)をローカルストアから返します。 | DataManager | ||
getCacheDescriptors(view:ListCollectionView, options:uint = 0, item:Object = null):mx.rpc:AsyncToken
指定した ListCollectionView(コレクション)インスタンスを CacheDataDescriptor インスタンスで塗りつぶします。 | DataManager | ||
指定した ListCollectionView(コレクション)インスタンスを、アプリケーションで前に使用したすべてのキャッシュ識別子で塗りつぶします。 | DataManager | ||
指定した ID に一致するアイテムの非同期要求を行います。 | DataManager | ||
特定の ID を持つアイテムを検索します。 | DataManager | ||
指定したコレクションのページ情報を返します。 | DataManager | ||
指定したアイテムに関連する、メッセージキャッシュ内で保留状態の操作を返します。 | DataManager | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
DataStore を強制的に初期化します。 | DataManager | ||
渡されたコレクションがこのサービスによって管理されている場合は true を返します。 | DataManager | ||
渡されたコレクションでページング機能が使用されている場合は true を返します。 | DataManager | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
指定した範囲のアイテムがすべてページングの対象に含まれる場合は true を返します。 | DataManager | ||
関連する <fill-method> 要素(ローカルストアのデータ)に基づいて、指定した ListCollectionView を塗りつぶします。 | DataManager | ||
保留状態のすべての更新を、管理対象のオブジェクトのセットにマージします。 | DataManager | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
この DataManager インスタンスによって管理されているすべてのデータを更新します。 | DataManager | ||
fill メソッドによって既に内容が設定されたコレクション、または管理対象の関連付けとして管理されている配列コレクションを更新します。 | DataManager | ||
DataManager インスタンスの管理対象コレクションとアイテムをすべて解放します。 | DataManager | ||
releaseCollection(view:ListCollectionView, clear:Boolean = false, copyStillManagedItems:Boolean = true):void
指定したコレクション内のすべてのアイテムを、この DataManager インスタンスの管理対象から解放します。 | DataManager | ||
releaseItem(item:IManaged, copyStillManagedItems:Boolean = true, enableStillManagedCheck:Boolean = true):IManaged
指定したアイテムをこの DataManager インスタンスの管理対象から解放します。 | DataManager | ||
指定した範囲に含まれるコレクション内のアイテムを解放します。 | DataManager | ||
単一値の関連付けの値を解放します。 | DataManager | ||
指定したアイテムに対する未コミットの変更を元に戻します。 | DataManager | ||
指定したコレクションに含まれ、この DataManager インスタンスで管理する必要があるアイテムに加えられたすべての変更を元に戻します。 | DataManager | ||
このメソッドで、DataManager インスタンスのキャッシュの現在の状態が保存されます。 | DataManager | ||
ローカルキャッシュに保存されていないこのオブジェクトに対する保留状態の変更があるかどうかを示します。 | DataManager | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
このデータサービス(データマネージャー)で以前に実行されたすべての fill に対して変更されたアイテムを取得します。 | DataManager | ||
[静的]
すべてのローカルデータの同期を許可するコンビニエンスメソッドです。synchronizeAllFills() の個々の呼び出しがすべて完了したときにのみ最終結果トークンが完了するように指定された各データサービス(データマネージャー)で、synchronizeAllFills() が呼び出されます。 | DataManager | ||
fill または synchronizeFill が前回呼び出されてから、サーバーで変更されたアイテムを取得します。 | DataManager | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
指定したアイテムに対する更新をトリガーします。 | DataManager | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object |
メソッド | 定義元 | ||
---|---|---|---|
このデータマネージャーがまだ初期化されていない場合、フォルトをキューに格納します。 | DataManager |
イベント | 概要 | 定義元 | ||
---|---|---|---|---|
ローカルで保留状態の変更と別のクライアントによって送信された変更の間で競合が検出された場合、またはこのクライアントによって送信された変更がリモート宛先での変更と競合している場合は、DataConflictEvent.CONFLICT イベントが送出されます。 | DataManager | |||
DataManagerFaultEvent.FAULT イベントは、エラーのためにサービスの呼び出しが失敗したときに送出されます。 | DataManager | |||
リモート宛先からデータ操作に関する通知がプッシュされると、MessageEvent.MESSAGE イベントが送出されます。 | DataManager | |||
このサービスのプロパティが変更されると、PropertyChangeEvent.PROPERTY_CHANGE イベントが送出されます。 | DataManager | |||
サービスの呼び出しに成功すると、ResultEvent.RESULT イベントが送出されます。 | DataManager |
adapter | プロパティ |
public var adapter:DataServiceAdapter = null
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
サーバーとの対話を制御するクラスのインスタンスです。
autoCommit | プロパティ |
autoCommit:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ローカルキャッシュに対する変更を自動的にコミットするかどうかを示します。コミットされた変更は、直ちにリモートサーバーへ送信されます。
DataService インスタンスのデフォルト値は true です。DataService インスタンスは、サーバー側の Data Management Service で使用されるデータマネージャーです。
RPCDataManager インスタンスのデフォルト値は false です。RPCDataManager インスタンスは、RemoteObject、HTTPMultiService、WebService などの RPC サービスコンポーネントにクライアント側のデータ管理機能を提供するデータマネージャーです。
実装
public function get autoCommit():Boolean
public function set autoCommit(value:Boolean):void
autoConnect | プロパティ |
autoConnect:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
接続を必要とする操作を処理する場合に、このサービスで接続を試みる必要があるかどうかを示します。サービスが切断されていて、autoConnect
が true
に設定されている場合、fill()
、getItem()
、count()
などの操作を処理する際には接続が試みられます。状況に応じて接続されるアプリケーション動作を制御するには、このプロパティを使用します。
デフォルト値: true。
実装
public function get autoConnect():Boolean
public function set autoConnect(value:Boolean):void
autoMerge | プロパティ |
autoMerge:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
false
に設定した場合、リモート宛先からクライアントにプッシュされた変更は、直ちには適用されません。代わりに、mergeRequired
プロパティが true に設定されます。
イベントハンドラーを登録すると、このプロパティに対する変更イベントをリスニングして、マージを適用する必要があるときに通知を受け取ることができます。
merge()
メソッドを呼び出して変更を結合すると、すべての変更が適用されます。
マージが必要な変更がある場合、未コミットの変更をコミットすることはできません。
ページングが有効になっている場合、ローカルでないアイテムに対する要求はすべて、merge()
が呼び出されるまでキャッシュに格納されます。merge()
を呼び出すと、キャッシュ内の要求が処理されます。
デフォルト値: true。
実装
public function get autoMerge():Boolean
public function set autoMerge(value:Boolean):void
autoSaveCache | プロパティ |
autoSaveCache:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
データのローカルキャッシュと変更をディスクに格納できます。autoSaveCache
プロパティを true
に設定すると、変更が加えられるたび、またはリモート要求が返されるたびに、データがディスクに保存されます。ディスクに空きがないため、または書き込み権限がないために、データを保存できない場合は、FaultEvent
が送出されるか、Fault
がスローされます。
この値を false
(デフォルト)に設定した場合、データと変更はディスクに保存されません。現在のデータと変更を強制的にディスクに保存するには、saveCache
メソッドを使用します。
デフォルト値: false。
実装
public function get autoSaveCache():Boolean
public function set autoSaveCache(value:Boolean):void
関連する API エレメント
autoSyncEnabled | プロパティ |
autoSyncEnabled:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
これを true
に設定して、fill()
、createItem()
、または getItem()
要求を発行すると、リモート宛先からこれらのアイテムに加えられた更新をリスニングするアイテムが返されます。このプロパティの値を変更した場合、その設定はこれらのメソッドがその後に呼び出された場合にのみ適用され、既存のコレクションやアイテムには適用されません。
また、autoSyncEnabled
を指定して取得したコレクションと、autoSyncEnabled
を指定せずに作成したコレクションが混在する場合は、両方のコレクションに含まれるすべてのアイテムが更新イベントを受け取り続けます。
デフォルト値: true。
実装
public function get autoSyncEnabled():Boolean
public function set autoSyncEnabled(value:Boolean):void
cacheID | プロパティ |
cacheID:String
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このサービスのキャッシュ識別子へのアクセスを提供します。ローカルディスクに格納されているデータとの対話が必要な操作を実行するときは、事前にキャッシュ識別子を設定する必要があります。キャッシュ識別子が設定されていない場合は、すべてのキャッシュメソッドとプロパティが不整合と見なされ、ローカルディスクのデータを必要とする操作が行われるときに DataServiceError
がスローされます。このプロパティは、ローカルに格納されているデータに対して一意の「セッション」識別子を提供します。開発者は、このプロパティをアプリケーションごとに一意の値に設定する必要があります。
null
または空のストリングは未設定と見なされます。fill()
や getItem()
などのメソッドによりデータが要求された場合、cacheID
が設定されているときは、最初にディスク上のローカルデータへのアクセスが試みられます。cacheID
が設定されていない場合は、ローカルデータへのアクセスは試みられません。
実装
public function get cacheID():String
public function set cacheID(value:String):void
commitRequired | プロパティ |
commitRequired:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
未コミットの変更があり、commit()
メソッドを呼び出す必要があるかどうかを示します。このプロパティが変更されると、イベントが送出されます。このプロパティをアプリケーション内で使用すると、視覚的なフィードバックを提供できます。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get commitRequired():Boolean
conflictDetector | プロパティ |
conflictDetector:ConflictDetector
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
この DataManager インスタンスにプッシュされたリモート操作に関する競合を検出するために使用されている現在の実装へのアクセスを提供します。
実装
public function get conflictDetector():ConflictDetector
public function set conflictDetector(value:ConflictDetector):void
conflicts | プロパティ |
conflicts:Conflicts
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
Conflicts オブジェクト(Conflict インスタンスの ArrayList)を格納します。
競合は commit()
メソッドを呼び出す前に解決する必要があります。競合を解決するには、個々の競合を 1 つずつ解決するか、このプロパティに対して acceptAllClient()
メソッドまたは acceptAllServer()
メソッドを呼び出します。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get conflicts():Conflicts
connected | プロパティ |
connected:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataService がリモート宛先に接続されているかどうかを示します。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get connected():Boolean
dataStore | プロパティ |
dataStore:DataStore
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
mx.data.DataStore 型のオブジェクトを含みます。DataStore は、相互に参照関係を持つ可能性がある 1 つ以上の DataManager インスタンスに対する変更(追加、削除など)を管理します。DataStore に対してコミットを実行すると、その DataStore を使用する各 DataManager で保留状態の変更がすべてコミットされます。
デフォルトでは、DataManager インスタンスは、管理対象の関連付けプロパティを持ち、同じチャネルセットを共有している他のデータサービスと同じ DataManager を共有します。DataStore を共有している場合、1 つの DataManager に対して commit を呼び出すと、そのデータストアを使用しているすべての DataManager に対する変更がコミットされます。未コミットのバッチに含まれる変更の間に依存関係がある場合、操作の順序は維持されます。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get dataStore():DataStore
public function set dataStore(value:DataStore):void
deleteItemOnRemoveFromFill | プロパティ |
deleteItemOnRemoveFromFill:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
デフォルトでは、既に内容が設定された管理対象のコレクションに対して removeItemAt()
メソッドを呼び出すと、サーバーに対してアイテム削除要求が発行され、アイテムが物理的に削除されます。これにより、管理対象のコレクションと管理対象外のコレクションを同じ方法で利用するコードを作成できます。ただし、状況によっては、サーバーからアイテムを削除せずに、クライアント上のコレクションからのみアイテムを削除したい場合があります。その場合は、removeItemAt()
メソッドを呼び出す前にこのフラグを false
に設定します。
これは関連付けられているコレクションには影響がないことに注意してください。fill()
メソッドで使用されたコレクションにのみ影響があります。
デフォルト値: true。
実装
public function get deleteItemOnRemoveFromFill():Boolean
public function set deleteItemOnRemoveFromFill(value:Boolean):void
encryptLocalCache | プロパティ |
encryptLocalCache:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
ランタイムバージョン: | Flash Player 9, AIR 1.5 |
SQL オフラインアダプターを使用する AIR クライアントに対して、オフラインストレージを暗号化するかどうかを示します。
ブラウザーベースの Flex クライアントの場合、オフラインデータは暗号化できません。
実装
public function get encryptLocalCache():Boolean
public function set encryptLocalCache(value:Boolean):void
fallBackToLocalFill | プロパティ |
fallBackToLocalFill:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このフラグによって、アプリケーションに接続していない場合はアプリケーションがローカルストアに対してクエリするかどうかを決定します。デフォルトで、オフラインアダプターが動的クエリの実行をサポートするように設定されている場合、アプリケーションに接続していないときに fill()
を呼び出すと、ローカルストアはクエリされません。fallBackToLocalFill が true に設定されている場合、アプリケーションの接続が解除されるときと同様に、ローカルストアはクエリされます。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get fallBackToLocalFill():Boolean
public function set fallBackToLocalFill(value:Boolean):void
hierarchicalEventsDefault | プロパティ |
hierarchicalEventsDefault:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
関連付けでは、オプションで、関連付けられているインスタンスのプロパティに対するプロパティ変更イベントがリストされます。これは hierarchical-events
設定属性との関連付けに対して設定できます。hierarchical-events
属性を設定しない場合は、このプロパティを使用して特定の宛先に対する関連付けのデフォルト値が決定されます。
デフォルト値は false
です。(循環グラフではなく)ツリーにあるオブジェクトの場合、宛先に対してこれを true
に設定すると便利です。例えば、アイテムレンダラーでプロパティのプロパティを使用する場合、その関連付けプロパティに対してこれを true
に設定すると、これらのプロパティのプロパティが変更されたときにグリッドが更新されます。システムは、再帰的なイベントを送信したり、parent.child[0].child[1].child[3] のような長く続く一連のイベントを作成したりすることがないように設計されています。
デフォルト値: false。
実装
public function get hierarchicalEventsDefault():Boolean
public function set hierarchicalEventsDefault(value:Boolean):void
ignoreCollectionUpdates | プロパティ |
ignoreCollectionUpdates:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
ランタイムバージョン: | Flash Player 9, AIR 1.5 |
コミット時にサーバーに対して通信する代わりに、管理対象コレクションに対する変更を無視するかどうかを示します。
デフォルト値: false。
実装
public function get ignoreCollectionUpdates():Boolean
public function set ignoreCollectionUpdates(value:Boolean):void
indexReferences | プロパティ |
indexReferences:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
他のアイテムの関連付けプロパティからこの DataManager によって管理されるアイテムへの参照または fill の数が少ない場合は、このプロパティを false
に設定することで、アプリケーションの速度を改善できます。
実装
public function get indexReferences():Boolean
public function set indexReferences(value:Boolean):void
isInitialized | プロパティ |
isInitialized:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
この DataManager インスタンスと関連付けられているメタデータを初期化するかどうかを示します。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get isInitialized():Boolean
manualSync | プロパティ |
manualSync:ManualSyncConfiguration
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager インスタンスごとに ManualSyncConfiguration インスタンスへのアクセスを提供します。ManualSyncConfiguration クラスを使用すると、他のクライアントまたはサーバーで行われた変更をサブスクライブすることができ、このインターフェイスを使用してサブスクライブする他のクライアントに対して、このクライアントで行った変更をどのようにパブリッシュするかを制御できます。
実装
public function get manualSync():ManualSyncConfiguration
public function set manualSync(value:ManualSyncConfiguration):void
maxFrequency | プロパティ |
maxFrequency:uint
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager インスタンスが 1 秒間に受信できるメッセージの最大数を指定します。この値を理解するサーバーは、この値を入力として使用し、DataManager へのメッセージの送信速度を決定します。
デフォルト値は 0 です。つまり、DataManager にはメッセージ速度に関する環境設定がありません。このプロパティは DataManager がサブスクライブする前に設定する必要があり、サブスクリプション後の変更は DataManager がサブスクライブを解除して再サブスクライブするまで有効にならないことに注意してください。
デフォルト値: 0。
実装
public function get maxFrequency():uint
public function set maxFrequency(value:uint):void
mergeRequired | プロパティ |
mergeRequired:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
マージが必要な保留状態の変更があるかどうかを示します。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get mergeRequired():Boolean
offlineAdapter | プロパティ |
offlineAdapter:DataServiceOfflineAdapter
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
mx.data.DataServiceOfflineAdapter 型のオブジェクトを返します。オブジェクトをローカルストア(SQLLite/LSO)に保持する実装方法を制御する Offline Adapter コントロールです。
実装
public function get offlineAdapter():DataServiceOfflineAdapter
public function set offlineAdapter(value:DataServiceOfflineAdapter):void
pageSize | プロパティ |
pagingEnabled | プロパティ |
priority | プロパティ |
priority:int
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager インスタンスが送信するメッセージのデフォルトのメッセージ優先度です。有効な値は 0 ~ 9(0 が最小)です。-1 の場合、DataManager インスタンスには優先度が設定されません。メッセージの優先度が既に定義されている場合は、その優先度がこのプロパティよりも優先されることに注意してください。
実装
public function get priority():int
public function set priority(value:int):void
requestTimeout | プロパティ |
requestTimeout:int
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
操作の要求タイムアウト(秒単位)へのアクセスを提供します。ゼロ以下の値を設定すると、要求はタイムアウトになりません。requestTimeout
で指定した限度に達して現在の操作がタイムアウトすると、その操作に関してフォルトが送出され、要求がタイムアウトしたことが通知されます。操作がタイムアウトしても、サーバーが実際にはその操作を受け取った可能性があることに注意してください。その場合、クライアントとサーバーの間で同期が失われることがあります。
実装
public function get requestTimeout():int
public function set requestTimeout(value:int):void
resetCollectionOnFill | プロパティ |
resetCollectionOnFill:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
プロパティが true
の場合は、fill 操作の完了後に RESET イベントが送信されます。プロパティが false
の場合は、fill 結果から返されたアイテムごとに増分の ADD/REMOVE イベントが送信されます。このプロパティを設定すると、その後に開始されるすべての fill 操作に影響します。fill 操作が開始された後でこのプロパティを変更しても、進行中の fill の動作には影響しません。
デフォルト値: true。
実装
public function get resetCollectionOnFill():Boolean
public function set resetCollectionOnFill(value:Boolean):void
resubscribeAttempts | プロパティ |
resubscribeAttempts:int
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
接続を解除された DataManager インスタンスが、宛先に対して再サブスクライブを試行する回数を制御します。デフォルト値の -1 を使用すると、クライアントが再接続できるまで再サブスクライブが試みられます。
デフォルト値: -1。
実装
public function get resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void
resubscribeInterval | プロパティ |
resubscribeInterval:int
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
再サブスクライブの試みの間の遅延を制御します(ミリ秒単位)。デフォルトは 5000 で、5 秒ごとに再サブスクライブを試みることを意味します。
デフォルト値: 5000。
実装
public function get resubscribeInterval():int
public function set resubscribeInterval(value:int):void
saveCacheRequired | プロパティ |
saveCacheRequired:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 4.5 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ローカルキャッシュに保存されていない変更があって、saveCache()
メソッドを呼び出す必要があるかどうかを示します。このメソッドは、commitRequired が true を返す場合に false を返す可能性があります。その場合は、変更がローカルキャッシュには保存されているが、サーバーにはコミットされていないことを示します。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get saveCacheRequired():Boolean
subscribed | プロパティ |
subscribed:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager インスタンスがリモート宛先にサブスクライブされているかどうかを示します。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange
イベントが送出されます。
実装
public function get subscribed():Boolean
throwItemPendingErrors | プロパティ |
throwItemPendingErrors:Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
取得に時間がかかるデータやページングされていないデータにアクセスしたときに ItemPending エラーがスローされないようにするには、このプロパティを false
に設定します。その場合、エラーがスローされる代わりに、プロパティ値または ArrayCollection での getItemAt()
の呼び出しに対して null が返されます。
size()
メソッドは、サーバーからサイズ情報をまだ取得していないリストに対して、0 のエレメントを返します。サーバーからエレメントが返されると、適切な PropertyChangeEvent イベントおよび CollectionEvent イベントが送出されます。
実装
public function get throwItemPendingErrors():Boolean
public function set throwItemPendingErrors(value:Boolean):void
DataManager | () | コンストラクター |
public function DataManager()
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定された宛先を持つ DataService のインスタンスを作成します。宛先は、services-config.xml ファイルで設定された宛先に対する参照であることが必要です。
checkImplementation | () | メソッド |
protected function checkImplementation():void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このデータマネージャーがまだ初期化されていない場合、フォルトをキューに格納します。
clearCache | () | メソッド |
public function clearCache(value:Object = null):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
以前の saveCache()
メソッドの呼び出しによってディスクに格納されたデータ、または autoSaveCache
メソッドが true
に設定されている間にディスクに格納されたデータを消去します。
パラメーター
value:Object (default = null ) — Single Managed Object(SMO)オブジェクトまたは ArrayCollection へのオブジェクト参照です。
|
mx.rpc:AsyncToken — 操作の成功または失敗に対して応答するときに使用できる AsyncToken です。
|
clearCacheData | () | メソッド |
public function clearCacheData(descriptor:CacheDataDescriptor):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
渡された記述子で指定されているデータをローカルストアから消去します。
パラメーター
descriptor:CacheDataDescriptor — ローカルキャッシュから削除する必要があるデータに関する記述子への参照です。
|
mx.rpc:AsyncToken — 参照この操作に対する結果またはフォルトがいつ発生したかを確認するために使用できるトークンへの参照です。
|
commit | () | メソッド |
public function commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
この DataManager インスタンスに関連付けられている DataStore インスタンスによって現在管理されているすべてのコレクションに対する保留中の変更をコミットします。このメソッドを呼び出すことは、dataStore.commit()
メソッドを呼び出すことと同等です。
autoCommit
プロパティが true
であるときはトランザクションが使用されないので、このメソッドを呼び出す必要はありません。トランザクションを使用するには、autoCommit
プロパティを false
に設定し、このメソッドを直接呼び出して変更のバッチをコミットします。
通常は、引数を指定せずに「commit()
」を呼び出し、保留状態のすべての変更をコミットします。オプションの引数を指定すると、保留状態の変更の一部のみをコミットできます。DataStore 内のアイテムに対する変更をコミットするには、先に未解決の競合をすべて解決する必要があります。
アセンブラーで use-transactions が true
に設定されている場合は、すべての変更がアトミックにコミットされます。バッチで指定された操作が 1 つでも失敗した場合は、すべての操作が適用されません。use-transactions が false
に設定されている場合は、障害が発生するまで各操作が個別にコミットされ、障害が発生した時点で処理が停止します。エラーの前に発生した変更はすべて適用され、エラーの後に発生した変更は適用されません。バッチ処理でエラーが発生した場合は、すべての変更が未コミットのキューに戻されます。エラーの原因になった変更を削除する場合は、revertChanges を呼び出す必要があります。
デフォルトでは、commit メソッドを呼び出すと、この DataStore に対して作成、変更、および削除されたすべてのアイテムに対する保留状態の変更がすべてコミットされます。これらの変更の一部のみをコミットする場合は、バッチに含める変更を定義する管理対象 ArrayCollection インスタンスと管理対象アイテムの組み合わせを指定できます。指定した配列コレクションごとに、その配列コレクション内のアイテムのメンバーシップまたは順序に対する変更、またはその配列コレクション内のアイテムに対する変更がすべてコミットされます。また、個々の管理対象アイテムのリストを指定して、それらのアイテムに対する変更のみをコミットすることもできます。管理対象のコレクションまたはアイテムではないオブジェクトを itemsOrCollections パラメーターで指定すると、DataServiceError がスローされます。
itemsOrCollections パラメーターを使用していて、管理対象アイテムが他のアイテムを参照する関連付けパラメーターがある場合は、cascadeCommit パラメーターを使用して、関連付けられているアイテムに対する変更もバッチに含めるかどうかを制御できます。例えば、items パラメーターで Group アイテムを指定し、Group インスタンスに Person インスタンスのリストを参照する members プロパティがある場合、cascadeCommit を true にすると、Person インスタンスに対する変更もコミットされる変更のセットに含まれます。cascadeCommit が false の場合は、Group に対する変更のみが含まれます。従属するすべての変更をバッチに含めるには、cascadeCommit=true を使用します。
パラメーター
itemsOrCollections:Array (default = null ) — これはオプションのパラメーターであり、保留状態のすべての変更をコミットするときはデフォルトで null になります。保留状態の変更の一部のみをコミットする場合は、この引数を使用して、管理する ListCollectionView インスタンスと管理するアイテムのリストを指定します。ほとんど場合、ListCollectionView オブジェクトは、fill メソッドに渡した ArrayCollection です。このメソッドに適したアイテムは、各アイテムの管理対象バージョンです。これらは、getItem または createItem から取得されるアイテム、または getItemAt メソッドを使用して管理対象コレクションから取得されるアイテムです。この配列内のいずれかの値で定義されているアイテムの変更のみがコミットされます。
| |
cascadeCommit:Boolean (default = false ) — true の場合は、このリストで指定された関連アイテムに対する変更もコミットされます。
|
mx.rpc:AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の call プロパティで返される AsyncToken です。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。関連するアイテムが変更されていない場合は、AsyncToken の代わりに null が返されます。
|
例外
Error — 初期化が進行中の場合。これは、ランタイムの宛先が参照されていて、このサービスが初期化される前にコミットが呼び出された場合、または cacheID が設定されていて、ローカルキャッシュがロードされていない場合に、発生する可能性があります。どちらの場合も、commit を呼び出す前に、初期化の呼び出しまたは以前の操作から返されるトークンの結果またはフォルトを待つことで、エラーを防止できます。
|
commitRequiredOn | () | メソッド |
public function commitRequiredOn(object:Object):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3.1 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このオブジェクトについて保留状態の変更があるかどうかを示します。UI についてより細かく設定できます(通知のバインド可能なプロパティについては、commitRequired を参照してください)。
パラメーター
object:Object — 変更がある可能性のあるオブジェクトです。
|
Boolean — オブジェクトに保留状態の変更がある場合は true です。
|
connect | () | メソッド |
public function connect():mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このサービスからリモート宛先への接続を強制的に試みます。このメソッドを autoConnect
プロパティおよび disconnect()
メソッドと組み合わせて使用すると、接続のステータスを制御できます。
mx.rpc:AsyncToken — このサービスから送出される結果またはフォルトイベントにおいてこの操作を識別するトークンへの AsyncToken 参照です。connect() を呼び出すと、トークンの結果ハンドラーが常に呼び出され、結果はこのサービスの connected プロパティの現在の値になります。
|
count | () | メソッド |
public function count(... args):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
リモート宛先に対して count メソッドを呼び出します。呼び出される count メソッドは、関連付けられている <count-method> タグおよび渡されるパラメーターに基づきます。例えば、次のように count("firstName", "Bob")
を呼び出し、関連付けらた宛先の services-config.xml に <count-method> タグが存在しているか、または <count-method> タグが参照されているとします。
<count-method> <name>getCount</name> <params>java.lang.String,java.lang.String</params> <security-run-as name="freddie" password="nightmare" /> </count-method> <count-method> <name>getCount</name> <security-constraint ref="sample-users" /> </count-method>
パラメーター
... args — リモート宛先に渡す引数のリストです。
|
mx.rpc:AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の call プロパティで返されるオブジェクトです。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。
|
関連する API エレメント
createItem | () | メソッド |
public function createItem(item:Object):ItemReference
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したアイテムをリモートストア内に作成するように要求します。エラーが発生した場合は、DataConflictEvent イベントが送出されます。
パラメーター
item:Object — リモートストア内に作成する必要があるオブジェクトです。
|
ItemReference — ItemReference(AsyncToken を拡張します)。この参照は、ResultEvent.RESULT または FaultEvent.FAULT の token プロパティで返されます。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。このオブジェクトの result プロパティはバインド可能であり、返されるアイテムをバインドする目的に使用できます。アイテムが別のクライアントから削除された場合、この結果オブジェクトは null に設定されます。アプリケーションで ItemReference オブジェクトを保持する必要がある場合は、アイテムへの参照が終了した時点で、ItemReference インスタンスの releaseItem() メソッドを呼び出す必要があります。ItemReference インスタンスを保持する必要がない場合は、DataManager インスタンスに対して releaseItem() メソッドを使用すると、アイテム自体のインスタンスが解放されます。createItem() に失敗すると、フォルトが返されます。ただし、アイテムは保留状態のままです。アイテムを削除するには release() を呼び出す必要があります。
|
deleteItem | () | メソッド |
public function deleteItem(item:Object):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したアイテムをリモートストアから削除するように要求します。エラーが発生した場合は、DataConflictEvent イベントが送出されます。
パラメーター
item:Object — リモートストア内で削除する必要があるオブジェクトです。
|
mx.rpc:AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の token プロパティで返される AsyncToken です。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。
|
disconnect | () | メソッド |
public function disconnect():void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager インスタンスのネットワーク接続を解除します。このメソッドは、未処理のネットワーク操作が完了するまで待つことはしません。
executeQuery | () | メソッド |
public function executeQuery(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定された名前と引数を使用してクエリを実行します。通常、このメソッドは、クエリが特定の名前を持つ RPCDataManager インスタンスと共に使用します。fill メソッドの最初のパラメーターがストリング値である場合は、より一般的な方法で fill メソッドを使用して定義したクエリと共に、このメソッドを使用することもできます。queryName は fill の最初のパラメーターとして使用されます。
このメソッドによって返されたオブジェクトが不要になったときは、releaseCollection()
メソッド(結果がコレクションである場合)または releaseItem(結果が単一の値を取るアイテムである場合)を呼び出す必要があります。または、release()
メソッドを呼び出して、この DataManager インスタンスから取得された管理対象の参照をすべて解放することもできます。
このメソッドによって返されたコレクションの内容を更新するには、refreshCollection()
メソッドを呼び出します。
パラメーター
queryName:String — 呼び出す操作の名前です。
| |
propertySpecifier:PropertySpecifier — 取得するプロパティのセットです。
| |
... args — クエリに対する引数のリストです。
|
mx.rpc:AsyncToken — 結果を取得する AsyncToken の結果プロパティにバインドする AsyncToken です。または、結果プロパティ変更イベントをリスニングし、1 つ以上の応答側をトークンに追加し、トークンの動的プロパティとして追加情報を追加して、操作の結果を追跡できます。
|
fill | () | メソッド |
public function fill(value:ListCollectionView, ... args):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
宛先に関連付けられた塗りつぶし方式に基づいて、指定された ListCollectionView(コレクション)インスタンスを塗りつぶします。例えば、Hibernate アセンブラーを使用する LiveCycle Data Services の宛先の場合、fill()
メソッドの最初のパラメーターは塗りつぶすコレクション、2 番目のパラメーターは実行する Hibernate クエリ、その他のパラメーターは Hibernate クエリパラメーターです。モデル主導の開発ではサービスラッパークラスの fill()
メソッドに同じ形式が適用されます。
次に、Hibernate アセンブラーを使用する宛先の fill()
メソッドの例を示します。このアセンブラーには、description
というクエリパラメーターを使用する getByDescription
というクエリがあります。
ProductService.fill(ac, "getByDescription", description);
宛先の設定の XML 要素で fill メソッドを宣言する fill-method アプローチを使用する LiveCycle Data Services の宛先で、次の <fill-method> 要素が宛先の設定に含まれる場合は次のように操作します。
<fill-method> <name>loadPersons</name> <params>java.lang.String,java.lang.String</params> </fill-method> <fill-method> <name>loadPersons</name> <security-constraint ref="sample-users" /> </fill-method>この場合、最初の <fill-method> は 2 つのパラメーターを含み、<params> タグの型と数に一致するので、
fill(myCollection, "firstName", "Bob")
を呼び出すと、最初の <fill-method> が呼び出されます。同様に、fill(myCollection)
を呼び出すと、<params> タグを含まない 2 番目の <fill-method> タグが呼び出されます。
このコレクション内のアイテムに対する保留状態の変更がすべて削除されます。fill を呼び出すとコレクション内のすべてのデータがクリアされることに注意してください。既に内容を設定したコレクションを使用して fill を呼び出すこともできます。その場合、fill のパラメーターが同じである場合は、コレクションの内容が消去されてから、サーバーに対する fill メソッドが再び呼び出されます。fill のパラメーターが異なる場合は、古いコレクションが解放されて、新しいコレクションの内容が設定されます。
パラメーター
value:ListCollectionView — 指定した引数に基づいて内容を設定するコレクションへの参照です。
| |
... args — リモート宛先に渡す必要がある引数の変数リストです。
|
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、この fill 操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。このトークンは、ResultEvent.RESULT または FaultEvent.FAULT の call プロパティでも返されます。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。
|
fillSubset | () | メソッド |
public function fillSubset(value:ListCollectionView, ps:PropertySpecifier, ... args):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
宛先に関連付けられた塗りつぶし方式に基づいて、指定された ListCollectionView(コレクション)インスタンスを塗りつぶします。propertySpecifier
パラメーターで指定されたとおりに、各オブジェクトのプロパティのサブセットのみが設定されます。
パラメーター
value:ListCollectionView — 指定した引数に基づいて内容を設定するコレクションへの参照です。
| |
ps:PropertySpecifier — サーバーの fill の実装に渡す PropertySpecifier オブジェクトです。各アイテムで設定する必要があるプロパティのサブセットを指定します。
| |
... args — リモート宛先に渡す必要がある引数の変数リストです。
|
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、この fill 操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。このトークンは、ResultEvent.RESULT または FaultEvent.FAULT の call プロパティでも返されます。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。
|
findItem | () | メソッド |
public function findItem(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
単一のアイテムを返すクエリを実行します。
パラメーター
queryName:String — 呼び出す操作の名前です。
| |
propertySpecifier:PropertySpecifier — 取得するプロパティセットです。
| |
... args — クエリに対する引数のリストです。
|
mx.rpc:AsyncToken — 結果を取得する AsyncToken の結果プロパティにバインドする AsyncToken です。または、結果プロパティ変更イベントをリスニングし、1 つ以上の応答側をトークンに追加し、トークンの動的プロパティとして追加情報を追加して、操作の結果を追跡できます。
|
getCacheData | () | メソッド |
public function getCacheData(descriptor:CacheDataDescriptor):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ArrayCollection または Single Managed Object(SMO)をローカルストアから返します。このメソッドを呼び出しても、最終アクセス時刻は更新されません。
パラメーター
descriptor:CacheDataDescriptor — 指定したキャッシュデータの CacheDataDescriptor です。
|
mx.rpc:AsyncToken — この操作に対する結果またはフォルトがいつ発生したかを確認するために使用できるトークンへの AsyncToken 参照です。AsyncToken または関連付けられたイベントの結果プロパティには、各呼び出しの管理対象外となる ArrayCollection または ItemReference の新しいインスタンスが含まれます。
|
getCacheDescriptors | () | メソッド |
public function getCacheDescriptors(view:ListCollectionView, options:uint = 0, item:Object = null):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定した ListCollectionView(コレクション)インスタンスを CacheDataDescriptor インスタンスで塗りつぶします。引数が指定されていない場合、このサービスでキャッシュされているデータのすべての関連する CacheDataDescriptor インスタンスが返されます。
パラメーター
view:ListCollectionView — 指定した記述子を挿入できるコレクションへの ListCollectionView 参照です。
| |
options:uint (default = 0 ) — 次のいずれかの定数を指定する必要があります。
| |
item:Object (default = null ) — 特定の ItemReference 、管理対象アイテム、または ListCollectionView へのオブジェクト参照です。このパラメーターを指定すると、options 引数がオーバーライドされます。
|
mx.rpc:AsyncToken — このサービスから送出される結果またはフォルトイベントにおいてこの操作を識別するトークンへの AsyncToken 参照です。
|
getCacheIDs | () | メソッド |
public function getCacheIDs(view:ListCollectionView):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定した ListCollectionView(コレクション)インスタンスを、アプリケーションで前に使用したすべてのキャッシュ識別子で塗りつぶします。
パラメーター
view:ListCollectionView — アプリケーションでそれまでに使用されたすべてのキャッシュ識別子を挿入するコレクションへの ListcollectionView 参照です。
|
mx.rpc:AsyncToken — このサービスから送出される結果またはフォルトイベントにおいてこの操作を識別するトークンへの AsyncToken 参照です。
|
getItem | () | メソッド |
public function getItem(identity:Object, defaultValue:Object = null):ItemReference
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定した ID に一致するアイテムの非同期要求を行います。defaultValue
を指定して、そのアイテムが存在しない場合は、代わりに defaultValue
の情報を使用してアイテムが作成されます。このメソッドは ItemReference インスタンスを返します。getItem()
メソッドの呼び出しから有効なインスタンスが返された場合、そのアイテムのインスタンスを解放するには、releaseItem()
メソッドを呼び出す必要があります。ItemReference インスタンスを保持する必要がある場合は、releaseItem()
メソッドを呼び出して、適切な参照を解放する必要があります(クライアントが同じアイテムに対して getItem()
メソッドを複数回呼び出した場合)。ItemReference インスタンスを保持する必要がない場合は、アイテム自体の DataManager に対して releaseItem()
メソッドを呼び出せます。
パラメーター
identity:Object — 目的のオブジェクトに関する ID プロパティを含むオブジェクトです。
| |
defaultValue:Object (default = null ) — 存在しない場合に作成する必要がある、デフォルト値を持つ型のインスタンスです。
|
ItemReference — 取得するアイテムへの ItemReference インスタンスです。ItemReference インスタンスは AsyncToken を拡張するので、アイテムが取得されたとき、またはこの呼び出しでフォルトが発生したときに、通知を受け取るために使用することができます。DataManager インスタンスに対するイベントをリスニングしている場合、ItemReference インスタンスは ResultEvent.RESULT または FaultEvent.FAULT の token プロパティとして返されます。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。データバインディングを使用して、ItemReference インスタンスの result プロパティにバインドすることもできます。アイテムの内容がリモート宛先から設定され、そのアイテムがバインド可能である場合、ユーザーインターフェイスコントロールを ItemReference の result プロパティのプロパティに単純にバインドできるように、このプロパティは有効な値に設定されます。アイテムがサーバーまたは別のクライアントから削除された場合、この参照は null に設定されます。ItemReference には、アイテムを返すときにエラーが発生した場合、またはサーバーから null が返された場合に true に設定される invalid プロパティもあります。
|
getLocalItem | () | メソッド |
public function getLocalItem(identity:Object):Object
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
特定の ID を持つアイテムを検索します。指定したアイテムがこのクライアントで既に管理されている場合は、管理対象インスタンスが返されます。まだ管理されていない場合は、null が返されます。getItem
メソッドの呼び出しとは異なり、このメソッドはサーバーに要求を発行せず、追加の参照をアイテムに追加しません。
パラメーター
identity:Object — 目的のオブジェクトに関する ID プロパティを含むオブジェクトです。
|
Object — Object です。この ID を持つアイテムがこのクライアントでまだ管理されていない場合は、管理対象オブジェクトまたは null が返されます。
|
getPageInformation | () | メソッド |
public function getPageInformation(view:ListCollectionView):PageInformation
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したコレクションのページ情報を返します。
パラメーター
view:ListCollectionView — 対象のコレクションです。
|
PageInformation — 指定したコレクションのページ情報です。
|
getPendingOperation | () | メソッド |
public function getPendingOperation(item:Object):uint
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したアイテムに関連する、メッセージキャッシュ内で保留状態の操作を返します。アイテムに対して変更が加えられた場合に、変更の種類をユーザーに対して視覚的にフィードバックするには、このメソッドを使用します。
パラメーター
item:Object — テストする対象の IManaged オブジェクトです。
|
uint — どの操作が保留状態であるかを示します。アイテムに対して有効な操作は次のとおりです。
|
initialize | () | メソッド |
public function initialize():mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataStore を強制的に初期化します。
戻り値mx.rpc:AsyncToken — このサービスから送出される結果またはフォルトイベントにおいてこの操作を識別するトークンへの AsyncToken 参照です。
|
isCollectionManaged | () | メソッド |
public function isCollectionManaged(view:ListCollectionView):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
渡されたコレクションがこのサービスによって管理されている場合は true を返します。コレクションがこのサービスで管理されている場合は、コレクションを releaseCollection()
に渡して管理対象から解放しても安全です。
パラメーター
view:ListCollectionView — このサービスによって管理されているかどうかを調べる ListCollectionView 参照です。
|
Boolean — コレクションがこのサービスで管理されている場合は true を返し、そうでない場合は false を返します。
|
isCollectionPaged | () | メソッド |
public function isCollectionPaged(view:ListCollectionView):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
渡されたコレクションでページング機能が使用されている場合は true を返します。コレクションがこのサービスによってページングされている場合は、コレクションを releaseItemsFromCollection()
に渡してコレクション内の個々のアイテムを管理対象から解放しても安全です。
パラメーター
view:ListCollectionView — このサービスによって管理されているかどうかを調べる ListCollectionView 参照です。
|
Boolean — コレクションでページングが使用されている場合は true を返し、そうでない場合は false を返します。
|
isRangeResident | () | メソッド |
public function isRangeResident(view:ListCollectionView, startIndex:int, numberOfItems:int):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定した範囲のアイテムがすべてページングの対象に含まれる場合は true を返します。そうでない場合は false を返します。
パラメーター
view:ListCollectionView — このデータサービスによって管理されている ListCollectionView です。
| |
startIndex:int — ListCollectionView の開始インデックスです。
| |
numberOfItems:int — ListCollectionView 内のアイテムの数です。
|
Boolean — コレクションのアイテムがすべて存在する場合は true を返し、指定した範囲のアイテムが 1 つでも存在しない場合は false を返します。
|
localFill | () | メソッド |
public function localFill(value:ListCollectionView, ps:PropertySpecifier, ... args):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
関連する <fill-method> 要素(ローカルストアのデータ)に基づいて、指定した ListCollectionView を塗りつぶします。offlineAdapter.executeOfflineQuery() API を呼び出してデータをクエリし、アプリケーションに接続している場合でもリモート宛先へのクエリを試行しません。理想的には、データをクライアントに合わせて同期し、それに対してローカルクエリを実行する場合に使用されます。
パラメーター
value:ListCollectionView — 指定した引数に基づいて内容を設定するコレクションへの参照です。
| |
ps:PropertySpecifier — オフラインアダプターに渡す PropertySpecifier オブジェクトです。各アイテムで設定する必要があるプロパティのサブセットを指定します。
| |
... args — オフラインアダプターに渡す必要がある引数の args:Array 変数リストです。
|
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、このローカルの fill 操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。このトークンは、ResultEvent.RESULT または FaultEvent.FAULT の call プロパティでも返されます。
|
merge | () | メソッド |
public function merge():void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
保留状態のすべての更新を、管理対象のオブジェクトのセットにマージします。変更をマージするプロセスでは、競合が検出され、保留状態のアイテム要求がすべて処理されます。これで、この DataStore インスタンスを共有する他の DataManager インスタンスのすべてのメッセージがマージされます。
refresh | () | メソッド |
public function refresh():mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
この DataManager インスタンスによって管理されているすべてのデータを更新します。塗りつぶし、アイテム取得要求、およびページ要求がサーバーに対して実行され、すべての管理対象アイテムが再取得されます。DataStore.refresh()
メソッドを呼び出すと、関連付けが lazy = true に設定された関連アイテムもすべて更新されます。
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、更新操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。
|
refreshCollection | () | メソッド |
public function refreshCollection(value:ListCollectionView):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
fill メソッドによって既に内容が設定されたコレクション、または管理対象の関連付けとして管理されている配列コレクションを更新します。このメソッドは、サーバーに対して要求を発行し、このコレクションに対して最初に使用された fill パラメーターを使用するか、親アイテムからプロパティを取得することにより、コレクション内に存在するアイテムの新しいバージョンを取得します。何らかの変更が見つかった場合は、インクリメンタル方式でコレクションにマージされます。
パラメーター
value:ListCollectionView — この DataManager インスタンスによって管理されている ListCollectionView です。
|
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、この更新操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。ページングされたコレクションに関して更新するものが何もない場合は、null が返されます。このトークンは、ResultEvent.RESULT または FaultEvent.FAULT の call プロパティでも返されます。このオブジェクトにはカスタムデータを添付することができ、そのデータは後のイベント処理段階で検査できます。
|
release | () | メソッド |
public function release(clear:Boolean = true, copyStillManagedItems:Boolean = true):void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManager インスタンスの管理対象コレクションとアイテムをすべて解放します。
パラメーター
clear:Boolean (default = true ) — すべてのアイテムをリストから削除するかどうかを示すブール値です。なお、アイテムのコピーは作成されません。
| |
copyStillManagedItems:Boolean (default = true ) — このデータサービスを解放した後に、別のデータサービスからの管理対象関連付けの参照が、これらの管理対象オブジェクトの一部への参照を保持している可能性があるかどうかを示します。その場合は、このデータサービスの管理対象コレクションの一部が、現在もアクティブに管理されている可能性があります。このフラグに true を渡した場合、これらの参照は削除(clear=true)または複製(clear=flase)されます。このフラグに false を渡した場合、現在アクティブな参照はそのまま保持されます。false を使用すると、システムの状態を最もすばやくクリアできます。true を使用すると、このデータサービスから取得したコレクションまたはアイテムへの参照に、管理対象になる状態が存在しなくなります。
|
関連する API エレメント
releaseCollection | () | メソッド |
public function releaseCollection(view:ListCollectionView, clear:Boolean = false, copyStillManagedItems:Boolean = true):void
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したコレクション内のすべてのアイテムを、この DataManager インスタンスの管理対象から解放します。アイテムが複数のコレクションに存在する場合は、アイテムのコピーが作成されます。このコレクション内にのみ存在するアイテムに対する未コミットの変更(削除、作成、更新など)は解放されます。
パラメーター
view:ListCollectionView — リモートでの更新を今後受け取らないようにする必要がある ListCollectionView 参照です。
| |
clear:Boolean (default = false ) — すべてのアイテムをリストから削除するかどうかを示します。なお、アイテムのコピーは作成されません。
| |
copyStillManagedItems:Boolean (default = true ) — このコレクション内のアイテムに対する管理対象の参照がほかに存在するかどうかを示し、この呼び出しの後でコレクション内の管理対象アイテムが確実に存在しなくなるように、それらのアイテムのコピーを作成するかどうかを、このパラメーターで制御します。clear とこのオプションの両方を false に設定すると、最もすばやく管理対象の参照を解放できます。
|
releaseItem | () | メソッド |
public function releaseItem(item:IManaged, copyStillManagedItems:Boolean = true, enableStillManagedCheck:Boolean = true):IManaged
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したアイテムをこの DataManager インスタンスの管理対象から解放します。ItemReference インスタンスを保持する必要がある場合、getItem()
を複数回呼び出してクライアントアプリケーションの異なる部分から同じアイテムを取得した可能性がある場合は、ItemReference インスタンスに対して releaseItem()
メソッドを呼び出して適切な参照を解放します。
このメソッドを呼び出すと、ネストされたプロパティを含め、関連付けられているリソースがすべて解放されます。以後、指定したアイテムは、リモート宛先から更新を受け取らなくなります。また、このアイテムに対する未コミットの変更があり、そのアイテムが他のコレクションに存在しない場合は、それらの変更も解放されます。指定したアイテムが複数のコレクションに存在する場合、allowCopy
パラメーターを false
に設定していないと、元のアイテムのコピーが返されます。
パラメーター
item:IManaged — 解放するアイテムへの IManaged 参照です。
| |
copyStillManagedItems:Boolean (default = true ) — オブジェクトのグラフ内で引き続き管理されるアイテムのコピーを作成するかどうかを示すブール値です。値を false に設定すると、これらのアイテムへの参照は消去されます。
| |
enableStillManagedCheck:Boolean (default = true ) — 引き続き管理されるアイテムのコピーまたはクリアを無効にするために、このパラメーターに false の値を渡します。その場合、返される値は常に、解放した元の管理対象の値であり、別の参照がそのアイテムをまだ使用している場合は、解放後も引き続き管理されます。
|
IManaged — 解放するアイテムです。copyStillManagedItems が false に設定されていて、アイテムが別の参照によって管理されている場合、このアイテムはコピーです。
|
releaseItemsFromCollection | () | メソッド |
public function releaseItemsFromCollection(collection:ListCollectionView, startIndex:int, numberOfItems:int):int
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定した範囲に含まれるコレクション内のアイテムを解放します。大きいコレクションをページングしているときは、コレクション内のアイテムによって使用されているリソースを解放し、それらのアイテムに対する更新のサブスクライブを停止したい場合があります。解放する最初のアイテムの startIndex
と、解放するアイテムの数を指定します。指定した位置にあるアイテムがまだページングされていない場合、そのインデックスはスキップされます。
パラメーター
collection:ListCollectionView — 管理対象の ListCollectionView です。
| |
startIndex:int — 解放する最初のアイテムのインデックスです。
| |
numberOfItems:int — 解放するアイテムの、指定した位置からの数です。numberOfItems は 0 より大きい値に設定し、startIndex および numberOfItems は collection.length より小さい値にする必要があります。
|
int — 解放された参照の数です。
|
releaseReference | () | メソッド |
public function releaseReference(item:Object, propName:String):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
単一値の関連付けの値を解放します。値がページングの対象に含まれない場合は、false が返されます。値がページングの対象に含まれる場合は、その参照が解放されて、true が返されます。これが指定したアイテムへの最後の参照であった場合、次にそのアイテムへのアクセスを試みると、ItemPendingError が発生し、値が再び取得されます。
パラメーター
item:Object — プロパティとして単一値の関連付けを含む親アイテムです。
| |
propName:String — 単一値の関連付けを参照するプロパティの名前です。
|
Boolean — 値が解放された場合は true です。
|
revertChanges | () | メソッド |
public function revertChanges(item:IManaged = null):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したアイテムに対する未コミットの変更を元に戻します。アイテムが指定されていない場合、未コミットの変更はすべて元に戻されます。作成操作を元に戻すと、アイテムが削除されます。削除操作を元に戻すと、アイテムが再び追加されます。更新操作を元に戻すと、アイテムのプロパティが変更を開始する前の元の状態に戻されます。このメソッドを呼び出すことは、dataStore.revertChanges()
メソッドを呼び出すことと同等です。
このメソッドは、フォルトの発生後などに使用します。その場合、失敗した変更はすべて、未コミットの変更のリストに戻されます。その時点で、それらの変更を修正して問題を解決するか、このメソッドを使用して変更を元に戻すことで、それらの変更が再び送信されないようにすることができます。
アイテムが指定されていて、そのアイテムが変更されていない場合、このメソッドは false を返します。アイテムが指定されておらず、変更がない場合、このメソッドは false を返します。それ以外の場合は、true を返します。
パラメーター
item:IManaged (default = null ) — 元に戻す変更への参照です。すべての変更を元に戻す場合は null を指定します。
|
Boolean — 元に戻された変更があるかどうかを示すブール値です。
|
revertChangesForCollection | () | メソッド |
public function revertChangesForCollection(collection:ListCollectionView = null):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したコレクションに含まれ、この DataManager インスタンスで管理する必要があるアイテムに加えられたすべての変更を元に戻します。
パラメーター
collection:ListCollectionView (default = null ) — 元に戻すコレクションです。
|
Boolean — 変更が元に戻された場合、このブール値は true になります。
|
saveCache | () | メソッド |
public function saveCache(value:Object = null):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このメソッドで、DataManager インスタンスのキャッシュの現在の状態が保存されます。キャッシュには、メモリ内のアイテムと、それらのアイテムに対する変更のうち、まだリモート宛先に送信されていない変更が含まれます。
パラメーター
value:Object (default = null ) — 管理対象の ListCollectionView インスタンスまたはオブジェクトへのオブジェクト参照です。
|
mx.rpc:AsyncToken — 操作が正常に完了したとき、または失敗したときの通知に使用できる AsyncToken です。
|
関連する API エレメント
例 ( この例の使用方法 )
var customerService:DataService = new DataService("customers"); var customers:ArrayCollection = new ArrayCollection(); customerService.fill(customers); // ... var customer:Customer = Customer(customers[0]); customer.priority = "top"; customerService.saveCache(); // now all of the changes and items in the customers collection // will be persisted locally
saveCacheRequiredOn | () | メソッド |
public function saveCacheRequiredOn(object:Object):Boolean
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 4.5 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ローカルキャッシュに保存されていないこのオブジェクトに対する保留状態の変更があるかどうかを示します。このメソッドは、comitRequiredOn が true を返す場合に false を返す可能性があります。その場合は、変更がローカルキャッシュには保存されているが、サーバーにはコミットされていないことを示します。
パラメーター
object:Object — 変更がある可能性のあるオブジェクトです。
|
Boolean — オブジェクトに保留状態の変更がある場合は true です。
|
synchronizeAllFills | () | メソッド |
public function synchronizeAllFills():mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.0 |
このデータサービス(データマネージャー)で以前に実行されたすべての fill に対して変更されたアイテムを取得します。
戻り値mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、この 操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。
|
synchronizeDataServices | () | メソッド |
public static function synchronizeDataServices(services:Array):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.0 |
すべてのローカルデータの同期を許可するコンビニエンスメソッドです。synchronizeAllFills() の個々の呼び出しがすべて完了したときにのみ最終結果トークンが完了するように指定された各データサービス(データマネージャー)で、synchronizeAllFills() が呼び出されます。
パラメーター
services:Array — 同期するデータサービスの配列です。
|
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、この 操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。
|
synchronizeFill | () | メソッド |
public function synchronizeFill(... fillArgs):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 4.5 |
ランタイムバージョン: | Flash Player 10.1, AIR 2.0 |
fill または synchronizeFill が前回呼び出されてから、サーバーで変更されたアイテムを取得します。これらには、作成されたアイテム、更新されたアイテムおよび削除されたアイテムが含まれます。以前に fill が発生していない場合は、最初に fill を実行するのと同じになります。
パラメーター
... fillArgs — fill のパラメーターです。
|
mx.rpc:AsyncToken — AsyncToken です。このトークンを使用すると、この fill 操作の結果またはフォルトイベントを受け取るためのコールバック関数を登録できます。ChangedItems のインスタンスは、結果ハンドラーに渡される ResultEvent の結果オブジェクトとして使用され、返された変更アイテムが記述されています。
|
updateItem | () | メソッド |
public function updateItem(item:Object, origItem:Object = null, changes:Array = null):mx.rpc:AsyncToken
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定したアイテムに対する更新をトリガーします。管理対象のインスタンスを使用してこのメソッドを呼び出すと、そのアイテムに対する変更がすべてコミットされ、それらの変更の追跡に使用できるトークンが返されます。そのアイテムに関連する保留状態の変更がない場合は、null のトークンが返されます。インスタンスの別のコピーを使用してこのメソッドを呼び出すと、changes 配列内で変更されたプロパティが管理対象のインスタンスにコピーされてログに記録された後、それらの変更がコミットされます。autoCommit
が true
の場合、このアイテムに対する変更は直ちにコミットされます。false
の場合、commit()
メソッドが呼び出されるまで変更はキューに入れられます。
パラメーター
item:Object — 更新するアイテムです。
| |
origItem:Object (default = null ) — 変更が行われる前のアイテムのバージョンです。このバージョンは競合の検出に使用されます。null でもかまいません。
| |
changes:Array (default = null ) — 更新されたプロパティ名の配列です。パフォーマンスの改善に使用されます。null でもかまいません。
|
mx.rpc:AsyncToken — 変更の追跡に使用できる AsyncToken です(このアイテムに対する変更がコミットされると、フォルトまたは結果イベントが配信されます)。アイテムに対する変更が何もない場合は、null の AsyncToken が返され、キューには何も格納されません。
|
conflict | イベント |
mx.data.events.DataConflictEvent
プロパティ DataConflictEvent.type =
mx.data.events.DataConflictEvent.CONFLICT
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ローカルで保留状態の変更と別のクライアントによって送信された変更の間で競合が検出された場合、またはこのクライアントによって送信された変更がリモート宛先での変更と競合している場合は、DataConflictEvent.CONFLICT
イベントが送出されます。各 DataService は、この宛先のアイテムに関する競合イベントのみを送信します。関連する複数の宛先の競合を一度に処理する必要がある場合は、DataService で競合イベントを使用します。
CONFLICT
定数により、conflict
イベントのイベントオブジェクトの type
プロパティ値が定義されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
conflict | 発生した競合を保持する Conflict オブジェクトです。 |
message | このイベントに関連付けられたメッセージです。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
fault | イベント |
mx.data.events.DataServiceFaultEvent
プロパティ DataServiceFaultEvent.type =
mx.data.events.DataServiceFaultEvent.FAULT
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
DataManagerFaultEvent.FAULT
イベントは、エラーのためにサービスの呼び出しが失敗したときに送出されます。例えば、このイベントは、fill()
メソッドの呼び出しに失敗した場合などに送出されます。また、このイベントは、コミット結果の一部としてエラーを生成する各アイテムに関しても送出されます。その場合は、コミットによって返されたトークンが DataServiceFaultEvent に含まれていますが、フォルト内のアイテムおよびエラーメッセージのストリングは、エラーの原因になったアイテムごとに異なります。
FAULT
定数により、fault
イベントのイベントオブジェクトの type
プロパティ値が定義されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | true。関連付けられたトークンの responder.fault メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。 |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
fault | 発生した競合を保持する Fault オブジェクトです。 |
item | フォルトが発生したアイテムです。 |
identity | フォルトが発生したアイテムの ID です。 |
message | このイベントに関連付けられたメッセージです。 |
token | メソッドの呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
message | イベント |
mx.messaging.events.MessageEvent
プロパティ MessageEvent.type =
mx.messaging.events.MessageEvent.MESSAGE
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
リモート宛先からデータ操作に関する通知がプッシュされると、MessageEvent.MESSAGE
イベントが送出されます。例えば、リモート宛先でデータが更新されると、その変更をリスニングしているすべてのクライアントに更新操作が送信され、その操作はこの DataService でメッセージイベントに変換されます。
この定数の値は "message"
です。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
message | このイベントに関連付けられたメッセージです。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
propertyChange | イベント |
mx.events.PropertyChangeEvent
プロパティ PropertyChangeEvent.type =
mx.events.PropertyChangeEvent.PROPERTY_CHANGE
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このサービスのプロパティが変更されると、PropertyChangeEvent.PROPERTY_CHANGE
イベントが送出されます。この動作は次のプロパティに関して発生します。
commitRequired
mergeRequired
connected
PropertyChangeEvent.PROPERTY_CHANGE
定数により、イベントオブジェクトの type
プロパティ値が PropertyChange
イベント用に定義されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | コンストラクターによって決定されます。デフォルトは false です。 |
cancelable | コンストラクターによって決定されます。デフォルトは false です。 |
kind | 変更の種類。PropertyChangeEventKind.UPDATE または PropertyChangeEventKind.DELETE のいずれかです。 |
oldValue | 元のプロパティの値です。 |
newValue | 新しいプロパティの値(存在する場合)です。 |
property | 変更されたプロパティです。 |
source | 変更されたプロパティを含むオブジェクトです。 |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
result | イベント |
mx.rpc.events.ResultEvent
プロパティ ResultEvent.type =
mx.rpc.events.ResultEvent.RESULT
言語バージョン: | ActionScript 3.0 |
製品バージョン: | Adobe Digital Enterprise Platform Data Services for Java EE 3 |
ランタイムバージョン: | Flash Player 9, AIR 1.1 |
サービスの呼び出しに成功すると、ResultEvent.RESULT
イベントが送出されます。例えば、このイベントは、fill()
の呼び出しに成功した場合などに送出されます。
イベントオブジェクトの各プロパティには次の値が設定されています。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | true。関連付けられたトークンの responder.result メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。 |
currentTarget | イベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。 |
message | このイベントに関連付けられたメッセージです。 |
target | イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。 |
result | RPC 呼び出しが返す結果です。 |
token | メソッドの個々の呼び出しを表すトークン。 Asynchronous Completion Token パターンで使用されます。 |
Tue Jun 12 2018, 10:34 AM Z