MessageBatch

パッケージ	mx.data
クラス	public class MessageBatch
継承	MessageBatch EventDispatcher Object
実装	IExternalizable

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

変更のグループ（作成、更新、削除、および更新コレクションメッセージ）を表します。DataStore.currentBatch プロパティを使用してアクセス可能なオープン状態のバッチは常に 1 つ以上存在します。データバインディング、createItem（）、updateItem（）、または deleteItem（） 操作を通して自動的に検出されるプロパティ変更などの変更は、このバッチに格納されます。未コミットのバッチの現在のリストは、uncommittedBatches プロパティに格納されます。createBatch を呼び出して作成した新しいバッチは、リストの末尾に追加されます。このバッチは自動的に currentBatch になります。一度にコミットしたり元に戻したりできる変更のバッチは 1 つのみです。どちらの場合も、バッチは uncommittedBatches リストから自動的に削除されます。

変更の間に依存関係がある場合は、順序に従って変更をコミットまたは元に戻す必要があります。つまり、コミットする場合はリスト内で最も古いバッチから開始し（uncommittedBatches[0]）、元に戻す場合は最も新しいバッチから開始します（uncommittedBatches[uncommittedBatches.length - 1]）。

バッチに変更が含まれる場合は（つまり items.length > 0 の場合は）、commitRequired プロパティが true に設定されます。items プロパティには、このバッチに含まれる DataMessages のセットが格納されます。

properties プロパティを使用すると、MessageBatch にカスタム情報を格納できます。バッチの保存と復元は、saveCache メソッドを呼び出すたびに、またはオフライン機能を使用していて autoSaveCache が true のときは自動的に行われます。

各バッチには、batchMessage プロパティで関連付けられた DataMessage があります。サーバーと情報を交換する必要がある場合（さらに、バッチメッセージをサーバーに送信している場合）は、このメッセージのヘッダーに情報を格納できます。

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		batchMessage : DataMessage これはサーバーに送信されるバッチを表すために使用されるデータメッセージです。	MessageBatch
		commitRequired : Boolean [読み取り専用] このバッチに 1 つでも変更が存在する場合は true です。	MessageBatch
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		properties : Object = null このバッチに対して設定できるユーザー定義プロパティのセットです（オプション）。	MessageBatch

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		MessageBatch() コンストラクターです。	MessageBatch
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken バッチに含まれる変更をコミットします。	MessageBatch
		commitRequiredOn(item:Object):Boolean このアイテムについて保留状態の変更があるかどうかを示します。	MessageBatch
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getMessage(messageId:String):DataMessage 特定の ID のメッセージを返します。	MessageBatch
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		readExternal(input:IDataInput):void このメソッドはメッセージのバッチを非直列化します。	MessageBatch
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		removeMessage(msg:DataMessage):void 指定されたメッセージをこのバッチから削除します。	MessageBatch
		revertChanges(item:IManaged = null):Boolean このバッチに含まれる変更を元に戻します。アイテムを何も指定しない場合はすべての変更が元に戻され、特定のアイテムを指定した場合はそのアイテムに対する変更のみが元に戻されます。	MessageBatch
		revertChangesForCollection(collection:ListCollectionView):Boolean 指定した管理対象コレクションに含まれるすべてのアイテムに対する変更を元に戻します。	MessageBatch
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String [オーバーライド] このオブジェクトのストリング表現を返します。	MessageBatch
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher
		writeExternal(output:IDataOutput):void このメソッドを呼び出すとバッチが直列化され、次の構造体が返されます。numberOfElements:int - これは直列化されたエレメントの総数です（繰り返されるエレメント、バッチ内のメッセージごとに 1 回）。destination:String - 関連付けられている DataService の宛先です。uid:String - 関連付けられているアイテムの UID です。message:DataMessage - 関連付けられている変更のメッセージです。現在、このメッセージにはアイテムのコピーが含まれているので、特別な方法でメッセージを直列化する必要はありません。	MessageBatch

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	イベント		概要	定義元
		activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
		deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

パブリック定数

	定数		定義元
		items : ArrayCollection バッチに含まれる変更を表す MessageCacheItem インスタンスのリストを格納します。	MessageBatch

プロパティの詳細

batchMessage

プロパティ

public var batchMessage:DataMessage

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

これはサーバーに送信されるバッチを表すために使用されるデータメッセージです。トランザクションごとに追加情報を渡す必要がある場合は、このメッセージのヘッダーを使用してサーバーのコードと通信します（クライアント上でメッセージを変換するのではなく、実際にメッセージを送信する必要があります）。

commitRequired

プロパティ

commitRequired:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このバッチに 1 つでも変更が存在する場合は true です。このプロパティはバインド可能です。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 propertyChange イベントが送出されます。

実装
public function get commitRequired():Boolean

properties

プロパティ

public var properties:Object = null

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このバッチに対して設定できるユーザー定義プロパティのセットです（オプション）。

コンストラクターの詳細

()

コンストラクター

public function MessageBatch()

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

メソッドの詳細

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

バッチに含まれる変更をコミットします。通常は引数を指定しないで呼び出します。

パラメーター

	`itemsOrCollections:Array` (default = `null`) — バッチに含まれる変更の一部のみをコミットする場合は、`itemsOrCollections` パラメーターを設定することで、1 つのアイテムまたは複数のアイテムに対する変更をコミットできます。

	`cascadeCommit:Boolean` (default = `false`) — `true` に設定すると、関連するアイテムに対する変更もコミットされます。

戻り値

mx.rpc:AsyncToken — このサービスから送出される結果またはフォルトイベントにおいてこの操作を識別するトークンへの AsyncToken 参照です。

commitRequiredOn

()

メソッド

public function commitRequiredOn(item:Object):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

ランタイムバージョン:

Flash Player 9, AIR 1.1

このアイテムについて保留状態の変更があるかどうかを示します。

パラメーター

item:Object — 変更がある可能性のあるオブジェクトです。

戻り値

Boolean — アイテムに保留状態の変更がある場合は true です。

getMessage

()

メソッド

public function getMessage(messageId:String):DataMessage

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

特定の ID のメッセージを返します。指定した ID のメッセージがこのバッチにない場合は null を返します。

パラメーター

messageId:String — 取得するメッセージの ID です。

戻り値

DataMessage — 指定した ID のメッセージ。指定した ID のメッセージがこのバッチにない場合は null を返します。

readExternal

()

メソッド

public function readExternal(input:IDataInput):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このメソッドはメッセージのバッチを非直列化します。次の構造を持つ入力バイトストリームを受け入れます。

numberOfElements:int - これは直列化された要素の合計数 [繰り返しの要素（バッチ内のメッセージごとに 1 回）] です
destination:String - 関連する DataService の宛先
uid:String - 関連するアイテムの UID
message:DataMessage - 関連する変更のメッセージ

パラメーター

input:IDataInput — 入力ストリーム

removeMessage

()

メソッド

public function removeMessage(msg:DataMessage):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたメッセージをこのバッチから削除します。

パラメーター

msg:DataMessage — 削除するメッセージです。

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

このバッチに含まれる変更を元に戻します。アイテムを何も指定しない場合はすべての変更が元に戻され、特定のアイテムを指定した場合はそのアイテムに対する変更のみが元に戻されます。以後の変更に影響する古い変更を元に戻すとシステムが依存関係を解決できなくなるので、通常は最新のバッチに含まれる変更のみを元に戻すようにする必要があります。

パラメーター

item:IManaged (default = null) — 元に戻すアイテムです。

戻り値

Boolean — 復元が正常に完了した場合は true を返します。

revertChangesForCollection

()

メソッド

public function revertChangesForCollection(collection:ListCollectionView):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定した管理対象コレクションに含まれるすべてのアイテムに対する変更を元に戻します。

パラメーター

collection:ListCollectionView — 元に戻すコレクションです。

戻り値

Boolean — 復元が正常に完了した場合は true を返します。

toString

()

メソッド

override public function toString():String

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このオブジェクトのストリング表現を返します。

戻り値

String — このオブジェクトのストリング表現です。

writeExternal

()

メソッド

public function writeExternal(output:IDataOutput):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このメソッドで、次の構造を持つバッチを直列化します。

numberOfElements:int - これは直列化された要素の合計数 [繰り返しの要素（バッチ内のメッセージごとに 1 回）] です
destination:String - 関連する DataService の宛先
uid:String - 関連するアイテムの UID
message:DataMessage - 関連する変更のメッセージ

メッセージにはアイテムのコピーが含まれるため、特別な方法でメッセージを直列化する必要はありません。

パラメーター

output:IDataOutput — 直列化されたバイトを書き込むオブジェクトです。

定数の詳細

items

定数

public const items:ArrayCollection

言語バージョン:

ActionScript 3.0

製品バージョン:

Adobe Digital Enterprise Platform Data Services for Java EE 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

バッチに含まれる変更を表す MessageCacheItem インスタンスのリストを格納します。これはバインド可能なので、このコレクションに対する変更イベントをリスニングすることで、新しい変更が発生したときに通知を受け取ることができます。

法律上の注意 | プライバシーポリシー

MessageBatch - AS3 ADEP Data Services

クラス x

batchMessage

commitRequired

properties

MessageBatch

commit

commitRequiredOn

getMessage

readExternal

removeMessage

revertChanges

revertChangesForCollection

toString

writeExternal

items