autoCommit:Boolean  [read-write]

バッファへの変更を自動的に完了するかどうかを示します。完了した変更は、すぐにリモートサービスに送信されます。

実装
    public function get autoCommit():Boolean
    public function set autoCommit(value:Boolean):void

autoMerge:Boolean  [read-write]

false に設定すると、リモート宛先からクライアントに変更がプッシュされたときに変更が即時には適用されなくなります。代わりに、mergeRequired プロパティに true が設定されます。このプロパティに対して変更イベントをリッスンするためのイベントハンドラを登録することで、結合を適用する必要があるときに通知を受け取ることができます。変更を結合するには、merge() メソッドを呼び出します。これにより、すべての変更が適用されます。結合が必要な変更があると、未完了の変更を完了することはできません。ページングが有効になっていると、ローカルでないアイテムに対するすべての要求は、merge() が呼び出されるまでキャッシュされます。merge() を呼び出すと、キャッシュされていた要求が処理されます。

実装
    public function get autoMerge():Boolean
    public function set autoMerge(value:Boolean):void

autoSyncEnabled:Boolean  [read-write]

true の場合、fill()、createItem()、getItem() の各要求は、リモート宛先からこれらのアイテムに対して行われた更新をリッスンするアイテムを返します。このプロパティ値が変更されると、これらのメソッドに対する将来の呼び出しに影響を与えますが、既存のコレクションまたはアイテムには影響を与えません。また、autoSyncEnabled を使用して取得されたコレクションと autoSyncEnabled を使用せずに設定されたコレクションとが混在する場合でも、両方のコレクションに出現する任意のアイテムで更新イベントを受信します。

実装
    public function get autoSyncEnabled():Boolean
    public function set autoSyncEnabled(value:Boolean):void

commitRequired:Boolean  [read-only]

完了していない変更があり、commit() メソッドを呼び出す必要があるかどうかを示します。このプロパティが変更されると、イベントが送出されます。このプロパティをアプリケーション内で使用し、視覚的なフィードバックを提供することができます。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get commitRequired():Boolean

conflictDetector:ConflictDetector  [read-write]

この DataService にプッシュされたリモート操作の競合を検出するために使用されている、現在の実装に対するアクセスを提供します。

実装
    public function get conflictDetector():ConflictDetector
    public function set conflictDetector(value:ConflictDetector):void

conflicts:Conflicts  [read-only]

Conflict インスタンスの ArrayList である Conflicts オブジェクトを返します。競合は、commit() を呼び出す前に解決する必要があります。競合を解決するには、個々の競合を 1 つずつ解決するか、このプロパティに対して acceptAllClient() メソッドまたは acceptAllServer() メソッドを呼び出します。

実装
    public function get conflicts():Conflicts

connected:Boolean  [read-only]

DataService がリモート宛先に接続されているかどうかを示します。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get connected():Boolean

dataStore:DataStore  [read-write]

mx.data.DataStore 型のオブジェクトを返します。DataStore は、1 つまたは複数の DataService に対して受信する変更と送信する変更のセットを管理します。DataService は相互に参照し合っていることがあります。DataStore 上で変更を完了すると、その DataStore を使用している各 DataService の保留状態の変更がすべて完了します。複数の DataService が管理された関連付けプロパティを持ち、同じチャンネルセットを共有している場合、デフォルトでは DataService は同じ DataStore を他の DataService と共有します。DataStores を共有している場合、ある DataService に対して 完了メソッドを呼び出すと、そのデータストアを使用しているすべての DataService の変更が完了します。完了していないバッチによる変更の間に依存関係がある場合に備え、操作の順序が維持されます。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get dataStore():DataStore
    public function set dataStore(value:DataStore):void

destination:String  [read-only]

このサービスが関連付けられているリモート宛先を示します。

実装
    public function get destination():String

mergeRequired:Boolean  [read-only]

結合が必要な保留中の変更があるかどうかを示します。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get mergeRequired():Boolean

pageSize:int  [read-write]

すべてのコレクションに対する現在のページサイズ設定へのアクセスを提供します。

実装
    public function get pageSize():int
    public function set pageSize(value:int):void

pagingEnabled:Boolean  [read-only]

リモート宛先がページング要求を許可するように設定されているかどうかを示します。

実装
    public function get pagingEnabled():Boolean

requestTimeout:int  [read-write]

操作のタイムアウト時間 (秒単位) に対するアクセスを提供します。ゼロ以下の値を設定すると、要求はタイムアウトになりません。requestTimeout の制限に達したことにより現在の操作がタイムアウトになると、その操作に関して、要求がタイムアウトになったことを示すフォルトが送出されます。

実装
    public function get requestTimeout():int
    public function set requestTimeout(value:int):void

public 関数 DataService(destination:String)

指定された宛先を持つ DataService のインスタンスを作成します。宛先は、services-config.xml ファイルで設定された宛先に対する参照であることが必要です。

パラメータ

destination:String — 目的の宛先の名前が格納されます。

public function commit():AsyncToken

現在このサービスで管理されているすべてのコレクションで保留状態の変更をすべて完了します。autoCommit プロパティが true の場合、トランザクションは使用されません。トランザクションを使用するには、autoCommit プロパティに false を設定し、このメソッドを直接呼び出します。

戻り値

AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の callプロパティで返される AsyncToken です。カスタムデータをこのオブジェクトに関連付け、後からイベント処理フェーズで調べることができます。

public function count(... args):AsyncToken

リモート宛先に対して count メソッドを呼び出します。呼び出される count メソッドは、関連付けられている <count-method> タグと渡されたパラメータに基づきます。たとえば、count("firstName", "Bob") を呼び出した場合を考えます。関連付けられている宛先の services-config.xml 中に、<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>
      

run-as セキュリティ設定のある最初の <count-method> は、2 つのパラメータを含んでおり、<params> タグの型と個数が一致します。このため、この <count-method> が呼び出されます。

パラメータ

... args — リモート宛先に渡すパラメータのリストです。

戻り値

AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の call プロパティで返されるオブジェクトです。カスタムデータをこのオブジェクトに関連付け、後からイベント処理フェーズで調べることができます。

関連項目

public function createItem(item:Object):ItemReference

指定したアイテムをリモートストアに作成することを要求します。エラーが発生すると、DataConflictEvent が送出されます。

パラメータ

item:Object — リモートストアに作成するオブジェクトです。

戻り値

ItemReference — ItemReference (AsyncToken を拡張します)。この参照は、ResultEvent.RESULT または FaultEvent.FAULT の token プロパティで返されます。カスタムデータをこのオブジェクトに関連付け、後からイベント処理フェーズで調べることができます。このオブジェクトの result プロパティはバインド可能で、返されたアイテムをバインドするために使用できます。アイテムが別のクライアントによって削除された場合、この結果のオブジェクトには null が設定されます。アプリケーションで ItemReference オブジェクトを保持する場合は、アイテムに対するこの参照を使い終えた時点で ItemReference の releaseItem() メソッドを呼び出す必要があります。ItemReference を保持しない場合は、DataService に対して releaseItem() メソッドを実行することができます。このメソッドは、解放するアイテム自体のインスタンスを受け取ります。

public function deleteItem(item:Object):AsyncToken

指定したアイテムをリモートストアから削除することを要求します。エラーが発生すると、DataConflictEvent が送出されます。

パラメータ

item:Object — リモートストアから削除するオブジェクトです。

戻り値

AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の token プロパティで返される AsyncToken です。カスタムデータをこのオブジェクトに関連付け、後からイベント処理フェーズで調べることができます。

public function disconnect():void

DataService のネットワーク接続を切断します。このメソッドは、未処理のネットワーク操作が完了するまで待つことはしません。

public function fill(value:ListCollectionView, ... args):AsyncToken

関連付けられている <fill-method> 要素に基づいて、指定された ListCollectionView を設定します。たとえば、以下の <fill-method> 要素が存在するか、関連付けられている宛先の services-config.xml で参照されているとします。

<fill-method>
<name>loadPersons</name>
<params>java.lang.String,java.lang.String</params>
<security-run-as name="freddie" password="nightmare" />
</fill-method>
            
<fill-method>
<name>loadPersons</name>
<security-constraint ref="sample-users" />
</fill-method>
      

この場合、fill(myCollection, ["firstName", "Bob"]) を呼び出すと、<params> タグの型と個数が一致する 2 つのパラメータが含まれているため、run-as セキュリティ設定がある最初の <fill-method> が呼び出されます。同様に、fill(myCollection) を呼び出すと、<params> タグが含まれていない 2 番目の <fill-method> タグが呼び出されます。保留中の変更やデータは、fill の呼び出しの中でクリアされます。

パラメータ

	value:ListCollectionView — 指定したパラメータで塗り潰すコレクションへの参照です。
	... args — rest: リモート宛先に渡すパラメータの配列変数リストです。

戻り値

AsyncToken — ResultEvent.RESULT または FaultEvent.FAULT の call プロパティで返されるオブジェクトです。カスタムデータをこのオブジェクトに関連付け、後からイベント処理フェーズで調べることができます。

public function getItem(identity:Object, defaultValue:Object = null):ItemReference

指定した ID に一致するアイテムに対して非同期要求を行います。defaultValue を指定し、アイテムが存在しないと、defaultValue の情報を使用してアイテムが作成されます。このメソッドは ItemReference を返します。getItem() メソッド呼び出しから有効なインスタンスを受け取ったら、releaseItem() メソッドを呼び出してアイテムのインスタンスを解放する必要があります。ItemReference を保持する場合は、参照に対して releaseItem() メソッドを呼び出し、正しい参照を確実に解放してください。これは、同じアイテムに対してクライアントが複数の getItem() メソッド呼び出しを行っていた場合に備えてのことです。ItemReference を保持しない場合は、DataService の releaseItem() メソッドを、アイテム自体を指定して呼び出すことができます。

パラメータ

	identity:Object — 目的のオブジェクトの ID プロパティが格納されたオブジェクトです。
	defaultValue:Object (default = null) — インスタンスが存在しない場合に作成される、デフォルト値を持ったインスタンスです。

戻り値

ItemReference — 取得するアイテムの ItemReference です。ItemReference は AsyncToken を拡張するため、これを使用して、アイテムが取得された場合やこの呼び出しが障害になった場合に通知を受け取ることができます。ItemReference は、DataService オブジェクトに対してイベントをリッスンしている場合、ResultEvent.RESULT または FaultEvent.FAULT の token プロパティとして返されます。カスタムデータをこのオブジェクトに関連付け、後からイベント処理フェーズで調べることができます。データバインディングを使用して ItemReference の result プロパティにバインドすることができます。アイテムがリモート宛先から値を設定されバインド可能な場合、このプロパティに有効な値が設定されます。そのため、ユーザーインターフェイスコントロールを ItemReference の result プロパティにバインドすることができます。アイテムがサーバーまたは別のクライアントから削除された場合、この参照には null が設定されます。ItemReference には invalid プロパティもあります。アイテムを返す際にエラーになったか、アイテムに対してサーバーが null を返すと、このプロパティに true が設定されます。

public function getPendingOperation(item:IManaged):uint

指定されたアイテムのメッセージキャッシュ中に保留されている操作を返します。このメソッドは、アイテムに対してどのような種類の変更が行われたかをユーザーに視覚的にフィードバックするために使用します。

パラメータ

item:IManaged — 検査の基準です。

戻り値

uint — 実行された保留中の操作を示す uint です。アイテムに対して有効な操作は以下のとおりです。 DataMessage.CREATE_OPERATION - 指定されたアイテムに対して作成が保留中であることを示します。 DataMessage.DELETE_OPERATION - 指定されたアイテムに対して削除が保留中であることを示します。 DataMessage.UPDATE_OPERATION - 指定されたアイテムに対して更新が保留中であることを示します。 DataMessage.UNKNOWN_OPERATION - 指定されたアイテムに対して保留中の操作がないことを示します。

public function logout():void

ユーザーを DataService の宛先からログアウトします。宛先からのログアウトは、サーバー設定で指定されているものと同じ ChannelSet を使用して接続されているあらゆるものに適用されます。たとえば、my-rtmp チャンネル上で接続しており、DataService インスタンスの 1 つを使用してログアウトすると、同じ ChannelSet 上で接続していたあらゆるユーザーがログアウトされます。

public function merge():void

保留中の更新を管理対象のオブジェクトセットに結合します。変更を結合する処理で競合が検出され、保留中のアイテム要求がすべて処理されます。これによって、この同じデータストアを共有している他のすべての DataService インスタンスのすべてのメッセージが結合されます。

public function release():void

DataService のすべての管理対象コレクションとアイテムを解放します。

関連項目

public function releaseCollection(view:ListCollectionView, clear:Boolean = false):void

指定したコレクション内のすべてのアイテムを、このサービスによる管理から解放します。アイテムが複数のコレクションに存在する場合は、アイテムのコピーが作成されます。このコレクションだけに存在するアイテムに対する完了していない変更は、削除、作成、更新を含め、すべて解放されます。

パラメータ

	view:ListCollectionView — これ以上リモート更新を受け取らない ListCollectionView の参照です。
	clear:Boolean (default = false) — すべてのアイテムをリストから削除するかどうかを示すブール値です。また、どのアイテムのコピーも作成されません。

public function releaseItem(item:IManaged, allowCopy:Boolean = true):IManaged

指定されたアイテムをこのサービスによる管理から解放します。ItemReferences を保持する場合は、ItemReference に対して releaseItem() メソッドを呼び出し、正しい参照を確実に解放してください。これは、クライアントアプリケーションの異なる部分から getItem を複数回呼び出し、同じアイテムを取得していた場合に備えてのことです。

この呼び出しによって、ネストしたプロパティを含め、関連付けられているすべてのリソースが解放されます。指定されたアイテムはリモート宛先からの更新は受け取らなくなります。また、このアイテムに対して完了していない変更があり、他のコレクションに現れない場合は、これらの変更も解放されます。指定されたアイテムが複数のコレクションに存在する場合は、allowCopy パラメータに false を設定しない限り、返される値は元のコピーとなります。

パラメータ

	item:IManaged — 解放するアイテムへの IManaged 参照です。
	allowCopy:Boolean (default = true) — オプションのパラメータで、デフォルトは true です。true の場合、アイテムが別の管理されている参照で使用されていると、アイテムのコピーが作成されます。false を設定することもできますが、他の参照によって管理されていた場合は、オブジェクトはサーバーから引き続き更新される可能性があることを意味します。

戻り値

IManaged — 解放されたアイテム。allowCopy=false の場合はコピーとなり、アイテムは別の参照によって管理されています。

public function revertChanges(item:IManaged = null):Boolean

指定したアイテムに対する完了していない変更をすべて元に戻します。アイテムを指定しないと、完了していない変更がすべて取り消されます。作成操作を取り消すと、アイテムが削除されます。削除を取り消すと、アイテムが復元されます。更新を取り消すと、変更を開始する前のアイテムの元のプロパティに戻ります。

このメソッドを使用する 1 つの状況は、障害が発生した後です。その場合、失敗した変更は未完了変更リストに戻されます。その時点で、これらの変更を修正して問題を解決するか、このメソッドを使用してこれらの変更が再度送信されないようにします。

アイテムが指定され、そのアイテムが変更されていない場合は、このメソッドは false を返します。アイテムが指定されず、変更がない場合は、このメソッドは false を返します。それ以外の場合は、true を返します。

パラメータ

item:IManaged (default = null) — 変更を取り消す対象となる参照です。すべての変更を取り消す場合は null を指定します。

戻り値

Boolean — 変更が取り消されたかどうかを示すブール値です。

public function setCredentials(username:String, password:String):void

この DataService の宛先に対して資格情報を設定します。証明書は、同じ ChannelSet 上で接続されているすべてのサービスに適用されます。

パラメータ

	username:String — 宛先のユーザー名です。
	password:String — 宛先のパスワードです。

public function setRemoteCredentials(username:String, password:String):void

この DataService の宛先のサードパーティの資格情報を設定します。

パラメータ

	username:String — 宛先のユーザー名です。
	password:String — 宛先のパスワードです。

イベントオブジェクトの型: mx.data.events.DataConflictEvent
DataConflictEvent.type property = mx.data.events.DataConflictEvent.CONFLICT

DataConflictEvent.CONFLICT イベントが送出されるのは、保留中のローカルな変更の間または別のクライアントから送信された変更の間に競合が検出された場合か、このクライアントから送信された変更がリモート宛先での変更と競合している場合です。各 DataService は、この特定の宛先のアイテムに対してだけ競合イベントを送信します。関連する宛先の競合を同時に複数処理する必要がある場合は、DataService に対する競合イベントを使用してください。

CONFLICT イベント型。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ	値
bubbles	false
cancelable	false
currentTarget	イベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
conflict	発生した競合を保持する Conflict オブジェクトです。
message	このイベントに関連付けられたメッセージ。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。

イベントオブジェクトの型: mx.data.events.DataServiceFaultEvent
DataServiceFaultEvent.type property = mx.data.events.DataServiceFaultEvent.FAULT

DataServiceFaultEvent.FAULT イベントは、サービス呼び出しがエラーで失敗した場合に送出されます。たとえば、fill() メソッドの呼び出しが失敗するとこのイベントが送出されます。完了の結果としてエラーを生成するアイテムでもこのイベントが送出されます。この場合、DataServiceFaultEvent には完了によって返されるトークンが格納されますが、障害のアイテムとエラーメッセージストリングは、エラーの原因となったアイテムに固有です。

FAULT イベントタイプです。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ	値
bubbles	false
cancelable	true。関連付けられたトークンの responder.fault メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。
currentTarget	イベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
fault	発生した競合を保持する Fault オブジェクト。
item	フォルトが発生したアイテムです。
item	フォルトが発生した項目の ID です。
message	このイベントに関連付けられたメッセージ。
token	メソッドの呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。

イベントオブジェクトの型: mx.messaging.events.MessageEvent
MessageEvent.type property = mx.messaging.events.MessageEvent.MESSAGE

MessageEvent.MESSAGE イベントは、リモート宛先がデータ操作の通知をプッシュするときに送出されます。たとえば、リモート宛先でデータが更新されると、リッスン中のすべてのクライアントに更新操作が送信され、この操作はこの DataService に対するメッセージイベントに変換されます。

MESSAGE イベント型。メッセージの受信時に送出されます。

この定数の値は "message" です。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ	値
bubbles	false
cancelable	false
currentTarget	イベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
message	このイベントに関連付けられたメッセージです。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。

イベントオブジェクトの型: mx.events.PropertyChangeEvent
PropertyChangeEvent.type property = mx.events.PropertyChangeEvent.PROPERTY_CHANGE

PropertyChangeEvent.PROPERTY_CHANGE イベントは、このサービスのプロパティが変更されたときに送出されます。以下のプロパティで起こります。

• commitRequired
• mergeRequired
• connected

PropertyChangeEvent.PROPERTY_CHANGE 定数により、PropertyChange イベントのイベントオブジェクトの type プロパティ値が定義されます。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ	値
bubbles	コンストラクタによって決定されます。デフォルトは false です。
cancelable	コンストラクタによって決定されます。デフォルトは false です。
kind	変更の種類。PropertyChangeEventKind.UPDATE または PropertyChangeEventKind.DELETE のいずれかです。
oldValue	元のプロパティの値です。
newValue	新しいプロパティの値 (存在する場合) です。
property	変更されたプロパティです。
source	変更されたプロパティを含むオブジェクトです。
currentTarget	イベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。

イベントオブジェクトの型: mx.rpc.events.ResultEvent
ResultEvent.type property = mx.rpc.events.ResultEvent.RESULT

ResultEvent.RESULT イベントは、サービス呼び出しが正常に返るときに送出されます。たとえば、fill() の呼び出しが成功するとこのイベントが送出されます。

RESULT イベントタイプです。

イベントオブジェクトの各プロパティには次の値が設定されます。

プロパティ	値
bubbles	false
cancelable	true。関連付けられたトークンの responder.result メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。
currentTarget	イベントを処理するイベントリスナーを定義するオブジェクト。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
message	このイベントに関連付けられたメッセージ。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
result	RPC 呼び出しが返す結果です。
token	メソッドの個々の呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。