Package | jp.co.fujitsu.reffi.client.flex.model.rpc |
Class | public class RPCCore |
Inheritance | RPCCore ![]() ![]() |
Subclasses | HTTPServiceCore, RemoteObjectCore, RPCControllerClientCore, WebServiceCore |
[概 要]
HTTP経由でRPC呼び出しを行う機能モデルの基底抽象モデルクラスです.[詳 細]
各種RPC通信クラスはこのクラスを継承して通信オブジェクト実体の生成、 通信成功、通信失敗ハンドラの実装を行います。 実装クラスのHTTPServiceCore、WebServiceCoreでは、 このクラスで定義されている返却フォーマットを設定することで、 レスポンスデータの型を指定することが出来ます。[備 考]
Copyright (c) 2008-2009 FUJITSU Japan All rights reserved.
See also
Property | Defined By | ||
---|---|---|---|
asyncToken : Object
[概 要]
非同期通信トークンです. | RPCCore | ||
cache : Dictionary [static]
[概 要]
static通信オブジェクトキャッシュプロパティです. | RPCCore | ||
cacheMode : Boolean
[概 要]
通信先が同じであれば各種通信オブジェクトをキャッシュします. | RPCCore | ||
![]() | controller : BaseController
[概 要]
このモデルを起動したコントローラインスタンスです. | BaseModel | |
![]() | executeIndex : int
[概 要]
実行インデックス設定. | BaseModel | |
![]() | parameterMapping : ParameterMapping
[概 要]
MVC各レイヤを伝播するパラメータオブジェクトです. | BaseModel | |
service : IEventDispatcher
[概 要]
継承先で定義される、各種通信オブジェクトのI/Fです. | RPCCore | ||
![]() | skip : Boolean
[概 要]
このモデルを実行するか、コントローラが判断する為のフラグです. | BaseModel | |
![]() | successCount : int
[概 要]
モデルインスタンス生存中に、何回モデル処理が成功したかを保持します. | BaseModel |
Method | Defined By | ||
---|---|---|---|
![]() | dispatchModelFailure(event:ModelProcessEvent):void
[概 要]
モデル処理失敗イベントを発行するメソッドです. | BaseModel | |
![]() | dispatchModelFinished(event:ModelProcessEvent):void
[概 要]
モデル処理完了イベントを発行するメソッドです. | BaseModel | |
![]() | dispatchModelSuccess(event:ModelProcessEvent):void
[概 要]
モデル処理成功イベントを発行するメソッドです. | BaseModel | |
![]() | incrementSuccessCount():int
[概 要]
ModelProcessEvent.SUCCESS発行回数を1増加させます. | BaseModel | |
removeAllCache():void [static]
[概 要]
通信オブジェクトキャッシュを全て削除します. | RPCCore | ||
removeCache(cacheId:String):void [static]
[概 要]
通信オブジェクトキャッシュを削除します. | RPCCore | ||
![]() | run():void
[概 要]
コントローラにコールされるモデルの主幹メソッドです. | BaseModel |
Method | Defined By | ||
---|---|---|---|
cacheId():String
[概 要]
キャッシュモード実行時、通信オブジェクトを識別する為のIDを返却します. | RPCCore | ||
createConcreteService():IEventDispatcher
[概 要]
具象イベントディスパッチャを作成します. | RPCCore | ||
faultHandler(event:FaultEvent):void
[概 要]
受信失敗ハンドラです. | RPCCore | ||
![]() | finallyProc():void
[概 要]
run()が終了したタイミングでテンプレートコールされるメソッドです. | BaseModel | |
finishConnect():void
[概 要]
通信成功、失敗に関わらずコールされます. | RPCCore | ||
mainProc():void [override]
[概 要]
メイン処理メソッドです. | RPCCore | ||
onFailure(event:FaultEvent, parameterMapping:ParameterMapping):void
[概 要]
受信失敗処理用オーバーライドメソッドです. | RPCCore | ||
onFinish(parameterMapping:ParameterMapping):void
[概 要]
通信終了処理実装メソッドです. | RPCCore | ||
onSuccess(event:ResultEvent, parameterMapping:ParameterMapping):void
[概 要]
受信成功処理用オーバーライドメソッドです. | RPCCore | ||
![]() | postProc():void
[概 要]
後処理テンプレートメソッドです. | BaseModel | |
![]() | preProc():Boolean
[概 要]
前処理テンプレートメソッドです. | BaseModel | |
resultHandler(event:ResultEvent):void
[概 要]
受信成功ハンドラです. | RPCCore | ||
send(dispathcer:IEventDispatcher):Object
[概 要]
RPC通信実行メソッドです. | RPCCore | ||
trap(e:Error):Error [override]
[概 要]
非同期通信開始前のエラーをハンドリングします. | RPCCore |
Constant | Defined By | ||
---|---|---|---|
E4X : String = e4x [static] レスポンス返却フォーマット「e4x」を示す定数です. | RPCCore | ||
OBJECT : String = object [static] レスポンス返却フォーマット「object」を示す定数です. | RPCCore | ||
XML : String = xml [static] レスポンス返却フォーマット「xml」を示す定数です. | RPCCore |
asyncToken | property |
asyncToken:Object
[概 要]
非同期通信トークンです.[詳 細]
cacheModeがtrue時、通信オブジェクトが複数のイベントハンドラを保持する以下のケースで判断されます。[備 考]
public function get asyncToken():Object
public function set asyncToken(value:Object):void
cache | property |
cache:Dictionary
[概 要]
static通信オブジェクトキャッシュプロパティです.[詳 細]
cacheModeがtrueの場合、使用した通信オブジェクトを、cacheIdをキーにして保存します。 このDictionaryからエントリを削除する場合、removeCacheメソッドを使用します。[備 考]
public static function get cache():Dictionary
public static function set cache(value:Dictionary):void
cacheMode | property |
cacheMode:Boolean
[概 要]
通信先が同じであれば各種通信オブジェクトをキャッシュします.[詳 細]
true設定された状態で通信を行うと、cacheスタティックDictionaryプロパティにキャッシュされます。 Dictionaryのキーは具象通信モデルのcacheIDが使用され、値として使用した通信オブジェクト が保存されます。 各種通信モデルのcacheIdメソッドは以下を返却します。[備 考]
public function get cacheMode():Boolean
public function set cacheMode(value:Boolean):void
service | property |
service:IEventDispatcher
[概 要]
継承先で定義される、各種通信オブジェクトのI/Fです.[詳 細]
HTTPServiceCoreはHTTPServiceオブジェクトを、 RemoteObjectCoreはRemoteObjectオブジェクトをこのプロパティに設定します。[備 考]
public function get service():IEventDispatcher
public function set service(value:IEventDispatcher):void
cacheId | () | method |
protected function cacheId():String
[概 要]
キャッシュモード実行時、通信オブジェクトを識別する為のIDを返却します.[詳 細]
このクラスを継承した場合は、必ずこのメソッドをオーバーライドし、cacheIdを返却します。 cacheIdはcacheModeプロパティがtrueの場合のみ使用されます。[備 考]
ReturnsString — 通信オブジェクトを識別する為のキャッシュID
|
createConcreteService | () | method |
protected function createConcreteService():IEventDispatcher
[概 要]
具象イベントディスパッチャを作成します.[詳 細]
このクラスを継承した場合は、必ずこのメソッドをオーバーライドし、通信オブジェクト実体を返却します。[備 考]
ReturnsIEventDispatcher — 通信オブジェクト
|
faultHandler | () | method |
protected final function faultHandler(event:FaultEvent):void
[概 要]
受信失敗ハンドラです.[詳 細]
受信失敗処理用メソッド「onFailure」のテンプレートコールを行い、 モデル失敗イベントModelProcessEvent.FAILUREを発行します。[備 考]
Parameters
event:FaultEvent — 通信失敗イベント
|
finishConnect | () | method |
protected function finishConnect():void
[概 要]
通信成功、失敗に関わらずコールされます.[詳 細]
イベントハンドラを解放します。[備 考]
通信終了処理実装はonFinishをオーバーライドしてください。mainProc | () | method |
override protected function mainProc():void
[概 要]
メイン処理メソッドです.[詳 細]
通信オブジェクトの実体を生成するcreateCocreteService()を 呼び出し、生成されたオブジェクトに対して受信成功ハンドラ 「resultHandler」、受信失敗ハンドラ「faultHandler」を追加します。[備 考]
onFailure | () | method |
protected function onFailure(event:FaultEvent, parameterMapping:ParameterMapping):void
[概 要]
受信失敗処理用オーバーライドメソッドです.[詳 細]
汎用的な受信失敗処理を記述したい場合、 モデルを継承してこのメソッドをオーバーライドします。[備 考]
Parameters
event:FaultEvent — 通信失敗イベント
| |
parameterMapping:ParameterMapping — パラメータマップ
|
onFinish | () | method |
protected function onFinish(parameterMapping:ParameterMapping):void
[概 要]
通信終了処理実装メソッドです.[詳 細]
通信成功、失敗に関わらずコールされます。 onSuccessまたはonFailureコール後にコールされます。 成功失敗共通の処理を実装することが出来ます。[備 考]
Parameters
parameterMapping:ParameterMapping |
onSuccess | () | method |
protected function onSuccess(event:ResultEvent, parameterMapping:ParameterMapping):void
[概 要]
受信成功処理用オーバーライドメソッドです.[詳 細]
汎用的な受信成功処理を記述したい場合、 モデルを継承してこのメソッドをオーバーライドします。[備 考]
Parameters
event:ResultEvent — 通信成功イベント
| |
parameterMapping:ParameterMapping — パラメータマップ
|
removeAllCache | () | method |
public static function removeAllCache():void
[概 要]
通信オブジェクトキャッシュを全て削除します.[詳 細]
cacheModeがtrue時、cacheプロパティに保存された通信オブジェクトを全て削除します。[備 考]
removeCache | () | method |
public static function removeCache(cacheId:String):void
[概 要]
通信オブジェクトキャッシュを削除します.[詳 細]
cacheModeがtrue時、cacheプロパティに保存された通信オブジェクトを削除します。[備 考]
Parameters
cacheId:String — キャッシュID
|
resultHandler | () | method |
protected final function resultHandler(event:ResultEvent):void
[概 要]
受信成功ハンドラです.[詳 細]
受信成功処理用メソッド「onSuccess」のテンプレートコールを行い、 モデル成功イベントModelProcessEvent.SUCCESSと、 モデル完了イベントModelProcessEvent.FINISHEDを発行します。[備 考]
Parameters
event:ResultEvent — 通信成功イベント
|
send | () | method |
protected function send(dispathcer:IEventDispatcher):Object
[概 要]
RPC通信実行メソッドです.[詳 細]
このクラスを継承した場合は、必ずこのメソッドをオーバーライドし、通信処理実行、AsyncTokenを返却します。[備 考]
Parameters
dispathcer:IEventDispatcher |
Object — AsyncToken
|
trap | () | method |
override protected function trap(e:Error):Error
[概 要]
非同期通信開始前のエラーをハンドリングします.[詳 細]
通信オブジェクトが生成されている場合、付与されているイベントリスナを削除し、 機能モデルへの参照を無くします。[備 考]
Parameters
e:Error |
Error |
E4X | Constant |
public static const E4X:String = e4x
レスポンス返却フォーマット「e4x」を示す定数です.
OBJECT | Constant |
public static const OBJECT:String = object
レスポンス返却フォーマット「object」を示す定数です.
XML | Constant |
public static const XML:String = xml
レスポンス返却フォーマット「xml」を示す定数です.