jp.go.aist.dmrc.platform.beans.datacooperation
クラス PFComponentPushTransferRequestReceivedComponent

java.lang.Object
  jp.go.aist.dmrc.platform.beans.datacooperation.PFComponentPushTransferRequestReceivedComponent

すべての実装されたインタフェース:

java.io.Serializable, PFComponent, PFXMLSerializable, PFPushComponentTransferReceivedEventSource, PFEventSource

public class PFComponentPushTransferRequestReceivedComponent
extends java.lang.Object
implements PFComponent, PFPushComponentTransferReceivedEventSource, PFXMLSerializable

簡易版コンポーネント転送機能を提供するコンポーネント.

このコンポーネントから以下のイベントが発生する.

イベント名	トリガ
PFPushComponentTransferRecieveEvent	プッシュ型コンポーネント転送を受信したとき

関連項目:

直列化された形式

コンストラクタの概要

PFComponentPushTransferRequestReceivedComponent()
コンストラクタ.

メソッドの概要

void	addPFPushComponentTransferReceivedListener(PFPushComponentTransferReceivedListener listener) 引数で与えられたイベントリスナを登録し、 PFPushComponentTransferReceivedEventイベント発生時に処理を行う対象とする.
boolean	getAllComponentTransferNotified() 自分以外をターゲットをする転送に応じて、 Pull型送信/Push型受信イベントを発生させるかの属性を取得する.
int	getComponentID() コンポーネントIDを取得する.
java.lang.String	getComponentKey() コンポーネントキーを取得する.
java.lang.String	getComponentName() コンポーネント名称を取得する.
java.lang.String	getComponentPublicName() コンポーネント公開名を取得する.
java.lang.String	getComponentString() コンポーネントの文字列表現を取得する.
boolean	getIsPushTransferTarget() Push型コンポーネント転送のターゲットになるかの可否属性を取得する.
java.util.Iterator	getPFPushComponentTransferReceivedListenerList() イベントリスナ配列を取得する.
int	getTargetComponentID() 転送対象のコンポーネントIDを取得する.
java.lang.String	getTargetComponentKey() 転送対象のコンポーネントキーを取得する.
java.lang.String	getTargetComponentName() 転送対象のコンポーネント名を取得する.
boolean	isAllowPullTransfer() 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowPushTransfer() 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
boolean	isAllowRemoteInvocation() 他PFからのコンポーネント連携要求に対する可否属性を取得する.
void	localeUpdated() ロケール更新への対応を行う.
void	readXML(PFXMLLoader in) コンポーネントのXML入力.
void	receiveComponent(java.lang.String requestID, int typeCode, java.lang.String requesrReceivedComp, java.lang.Object targetObj, int statusCode, java.lang.String errorLocation, java.lang.String errorMessage, java.lang.String detailedErrorMessage, int eventNo) Push型コンポーネント転送受信イベントを発生させる.
void	removePFPushComponentTransferReceivedListener(PFPushComponentTransferReceivedListener listener) 引数で与えられたイベントリスナを削除し、 PFPushComponentTransferReceivedEventイベント発生時に処理を行う対象から外す.
void	setAllComponentTransferNotified(boolean flag) 自分以外をターゲットをする転送に応じて、 Pull型送信/Push型受信イベントを発生させるかの属性を設定する.
void	setAllowPullTransfer(boolean flag) 他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowPushTransfer(boolean flag) 他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
void	setAllowRemoteInvocation(boolean flag) 他PFからのコンポーネント連携要求に対する可否属性を設定する.
void	setComponentID(int id) コンポーネントIDを設定する.
void	setComponentKey(java.lang.String key) コンポーネントキーを設定する.
void	setComponentPublicName(java.lang.String publicName) コンポーネント公開名を設定する.
void	setIsPushTransferTarget(boolean flag) Push型コンポーネント転送のターゲットになるかの可否属性を設定する.
void	setTargetComponentID(int aTargetComponentID) 転送対象のコンポーネントIDを設定する.
void	setTargetComponentKey(java.lang.String aTargetComponentKey) 転送対象のコンポーネントキーを設定する.
void	setTargetComponentName(java.lang.String aTargetComponentName) 転送対象のコンポーネント名を設定する.
void	writeXML(PFXMLGenerator out) コンポーネントのXML出力.

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PFComponentPushTransferRequestReceivedComponent

public PFComponentPushTransferRequestReceivedComponent()

コンストラクタ.

メソッドの詳細

getTargetComponentName

public java.lang.String getTargetComponentName()

転送対象のコンポーネント名を取得する.

戻り値:

転送対象のコンポーネント名

関連項目:

setTargetComponentName(java.lang.String)

setTargetComponentName

public void setTargetComponentName(java.lang.String aTargetComponentName)

転送対象のコンポーネント名を設定する.

パラメータ:

aTargetComponentName - 転送対象のコンポーネント名

関連項目:

getTargetComponentName()

getTargetComponentKey

public java.lang.String getTargetComponentKey()

転送対象のコンポーネントキーを取得する.

戻り値:

転送対象のコンポーネントキー

関連項目:

setTargetComponentKey(java.lang.String)

setTargetComponentKey

public void setTargetComponentKey(java.lang.String aTargetComponentKey)

転送対象のコンポーネントキーを設定する.

パラメータ:

aTargetComponentKey - 転送対象のコンポーネントキー

関連項目:

getTargetComponentKey()

getTargetComponentID

public int getTargetComponentID()

転送対象のコンポーネントIDを取得する.

戻り値:

転送対象のコンポーネントID

関連項目:

setTargetComponentID(int)

setTargetComponentID

public void setTargetComponentID(int aTargetComponentID)

転送対象のコンポーネントIDを設定する.

パラメータ:

aTargetComponentID - 転送対象のコンポーネントID

関連項目:

getTargetComponentID()

getComponentName

public java.lang.String getComponentName()

コンポーネント名称を取得する.

定義:

インタフェース PFComponent 内の getComponentName

戻り値:

コンポーネント名

getComponentKey

public java.lang.String getComponentKey()

コンポーネントキーを取得する.

定義:

インタフェース PFComponent 内の getComponentKey

戻り値:

コンポーネントキー文字列

関連項目:

setComponentKey(java.lang.String)

setComponentKey

public void setComponentKey(java.lang.String key)

コンポーネントキーを設定する.

定義:

インタフェース PFComponent 内の setComponentKey

パラメータ:

key - コンポーネントキー文字列

関連項目:

getComponentKey()

getComponentID

public int getComponentID()

コンポーネントIDを取得する.

定義:

インタフェース PFComponent 内の getComponentID

戻り値:

コンポーネントID

関連項目:

setComponentID(int)

setComponentID

public void setComponentID(int id)

コンポーネントIDを設定する.
コンポーネントIDはプラットフォームから設定される. 各コンポーネント内では操作しないこと.

定義:

インタフェース PFComponent 内の setComponentID

パラメータ:

id - 設定するコンポーネントID

関連項目:

getComponentID()

getComponentString

public java.lang.String getComponentString()

コンポーネントの文字列表現を取得する.
形式："Component Name" [ ID : "ID" ]

定義:

インタフェース PFComponent 内の getComponentString

戻り値:

文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()

コンポーネント公開名を取得する.

定義:

インタフェース PFComponent 内の getComponentPublicName

戻り値:

コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException

コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:

インタフェース PFComponent 内の setComponentPublicName

パラメータ:

publicName - 設定するコンポーネント公開名

例外:

PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()

他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:

インタフェース PFComponent 内の isAllowRemoteInvocation

戻り値:

コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)

他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:

インタフェース PFComponent 内の setAllowRemoteInvocation

パラメータ:

flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()

他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:

インタフェース PFComponent 内の isAllowPullTransfer

戻り値:

Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)

他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:

インタフェース PFComponent 内の setAllowPullTransfer

パラメータ:

flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()

他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:

インタフェース PFComponent 内の isAllowPushTransfer

戻り値:

Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)

他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:

インタフェース PFComponent 内の setAllowPushTransfer

パラメータ:

flag - Push型コンポーネント転送要求に対する可否

getIsPushTransferTarget

public boolean getIsPushTransferTarget()

Push型コンポーネント転送のターゲットになるかの可否属性を取得する.

戻り値:

Push型コンポーネント転送のターゲットになるかの可否

setIsPushTransferTarget

public void setIsPushTransferTarget(boolean flag)

Push型コンポーネント転送のターゲットになるかの可否属性を設定する.

パラメータ:

flag - Push型コンポーネント転送のターゲットになるかの可否

getAllComponentTransferNotified

public boolean getAllComponentTransferNotified()

自分以外をターゲットをする転送に応じて、 Pull型送信/Push型受信イベントを発生させるかの属性を取得する.

戻り値:

発生させる場合にはtrue

setAllComponentTransferNotified

public void setAllComponentTransferNotified(boolean flag)

自分以外をターゲットをする転送に応じて、 Pull型送信/Push型受信イベントを発生させるかの属性を設定する.

パラメータ:

flag - 発生させる場合にはtrue

localeUpdated

public void localeUpdated()

ロケール更新への対応を行う.

定義:

インタフェース PFComponent 内の localeUpdated

receiveComponent

public void receiveComponent(java.lang.String requestID,
                             int typeCode,
                             java.lang.String requesrReceivedComp,
                             java.lang.Object targetObj,
                             int statusCode,
                             java.lang.String errorLocation,
                             java.lang.String errorMessage,
                             java.lang.String detailedErrorMessage,
                             int eventNo)

Push型コンポーネント転送受信イベントを発生させる.

パラメータ:

requestID - リクエストID

typeCode - 転送タイプコード

requesrReceivedComp - 転送要求受信コンポーネント(の公開名)

targetObj - 転送対象コンポーネント

statusCode - ステイタスコード

errorLocation - エラーの発生場所

errorMessage - エラーメッセージ

detailedErrorMessage - 詳細なエラーメッセージ

eventNo - イベント番号

getPFPushComponentTransferReceivedListenerList

public java.util.Iterator getPFPushComponentTransferReceivedListenerList()

インタフェース PFPushComponentTransferReceivedEventSource の記述:

イベントリスナ配列を取得する.

定義:

インタフェース PFPushComponentTransferReceivedEventSource 内の getPFPushComponentTransferReceivedListenerList

戻り値:

イベントリスナイテレータ

addPFPushComponentTransferReceivedListener

public void addPFPushComponentTransferReceivedListener(PFPushComponentTransferReceivedListener listener)

インタフェース PFPushComponentTransferReceivedEventSource の記述:

引数で与えられたイベントリスナを登録し、 PFPushComponentTransferReceivedEventイベント発生時に処理を行う対象とする.

定義:

インタフェース PFPushComponentTransferReceivedEventSource 内の addPFPushComponentTransferReceivedListener

パラメータ:

listener - 追加対象イベントリスナ

関連項目:

PFPushComponentTransferReceivedEventSource.removePFPushComponentTransferReceivedListener(jp.go.aist.dmrc.platform.datacooperation.interfaces.PFPushComponentTransferReceivedListener)

removePFPushComponentTransferReceivedListener

public void removePFPushComponentTransferReceivedListener(PFPushComponentTransferReceivedListener listener)

インタフェース PFPushComponentTransferReceivedEventSource の記述:

引数で与えられたイベントリスナを削除し、 PFPushComponentTransferReceivedEventイベント発生時に処理を行う対象から外す.

定義:

インタフェース PFPushComponentTransferReceivedEventSource 内の removePFPushComponentTransferReceivedListener

パラメータ:

listener - 削除対象イベントリスナ

関連項目:

PFPushComponentTransferReceivedEventSource.addPFPushComponentTransferReceivedListener(jp.go.aist.dmrc.platform.datacooperation.interfaces.PFPushComponentTransferReceivedListener)

readXML

public void readXML(PFXMLLoader in)

コンポーネントのXML入力.

定義:

インタフェース PFXMLSerializable 内の readXML

パラメータ:

in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException

コンポーネントのXML出力.

定義:

インタフェース PFXMLSerializable 内の writeXML

パラメータ:

out - XML出力ユーティリティ

例外:

java.io.IOException