PFFunction (MZPlatform Component API)

java.lang.Object
- jp.go.aist.dmrc.platform.beans.util.controller.PFFunction

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

java.io.Serializable, PFComponent, PFXMLSerializable, PFEventSource, PFProcessRequestEventSource
```
public class PFFunction
extends java.lang.Object
implements PFComponent, PFProcessRequestEventSource, PFXMLSerializable
```
関数コンポーネント
このコンポーネントは、複合コンポーネントにおいて、公開メソッドを新しく定義するために使います。 call()もしくはcallWithList()メソッドを実行すると処理要求イベントが発生し、その処理結果を戻り値として返します。call()およびcallWithList()の実行に際して引数を指定することができ、これらの引数はgetFirstArgument()、getSecondArgument()、getThirdArgument()、 getFourthArgument()、getFifthArgument()、getArgument()の各メソッドで取得できます。
コンポーネントから発生するイベント
- 処理要求イベント
  
  トリガ処理要求データイベント番号
  call()もしくは
  callWithList()の実行引数リスト
  (PFObjectList) 0
関連項目:

直列化された形式

トリガ	処理要求データ	イベント番号
call()もしくは callWithList()の実行	引数リスト (`PFObjectList`)	0

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static int FUNCTION_CALL
関数呼び出しイベント番号

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`FUNCTION_CALL` 関数呼び出しイベント番号

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PFFunction()
コンストラクタ

コンストラクタ
コンストラクタと説明
`PFFunction()` コンストラクタ

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`void`	`addArgument(java.lang.Object arg)` 引数を追加する。
`void`	`addPFProcessRequestListener(PFProcessRequestListener lis)` 引数で与えられたイベントリスナを登録し、処理要求イベント発生時に処理を行う対象とする。
`java.lang.Object`	`call()` 引数０の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1)` 引数１の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2)` 引数２の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)` 引数３の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4)` 引数４の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5)` 引数５の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6)` 引数６の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7)` 引数７の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7, java.lang.Object arg8)` 引数８の関数を呼び出す。
`java.lang.Object`	`call(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5, java.lang.Object arg6, java.lang.Object arg7, java.lang.Object arg8, java.lang.Object arg9)` 引数９の関数を呼び出す。
`java.lang.Object`	`callWithCurrentArguments()` 現在設定されている引数で処理を呼び出す。
`java.lang.Object`	`callWithList(PFObjectList args)` 引数をリストとして与えて関数を呼び出す。
`void`	`clearAllArguments()` すべての引数をクリアする。
`int`	`countArguments()` 引数の数を取得する。
`java.lang.Object`	`getArgument(int index)` インデックスを指定して引数を取得する（第一引数のインデックスは0）。
`PFObjectList`	`getArgumentList()` 引数リストを取得する。
`int`	`getComponentID()` コンポーネントIDを取得する。
`java.lang.String`	`getComponentKey()` コンポーネントキーを取得する。
`PFMultiLocaleString`	`getComponentKeys()` 全ロケール分のコンポーネントキーを返す。
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`java.lang.String`	`getComponentPublicName()` コンポーネント公開名を取得する.
`java.lang.String`	`getComponentString()` コンポーネントの文字列表現を取得する。
`java.lang.Object`	`getEighthArgument()` 第八引数を取得する。
`java.lang.Object`	`getFifthArgument()` 第五引数を取得する。
`java.lang.Object`	`getFirstArgument()` 第一引数を取得する。
`java.lang.Object`	`getFourthArgument()` 第四引数を取得する。
`java.lang.Object`	`getNinthArgument()` 第九引数を取得する。
`java.util.Iterator`	`getPFProcessRequestListenerList()` 処理要求イベントリスナ配列を取得する。
`java.lang.Object`	`getSecondArgument()` 第二引数を取得する。
`java.lang.Object`	`getSeventhArgument()` 第七引数を取得する。
`java.lang.Object`	`getSixthArgument()` 第六引数を取得する。
`java.lang.Object`	`getThirdArgument()` 第三引数を取得する。
`boolean`	`isAllowPullTransfer()` 他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowPushTransfer()` 他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
`boolean`	`isAllowRemoteInvocation()` 他PFからのコンポーネント連携要求に対する可否属性を取得する.
`void`	`localeUpdated()` ロケール変更に対応する。
`void`	`readXML(PFXMLLoader in)` コンポーネントのXML入力.
`void`	`removePFProcessRequestListener(PFProcessRequestListener lis)` 引数で与えられたイベントリスナを削除し、処理要求イベント発生時に処理を行う対象から外す。
`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`	`setComponentKeys(PFMultiLocaleString keys)` 全ロケール分のコンポーネントキーを設定する。
`void`	`setComponentPublicName(java.lang.String publicName)` コンポーネント公開名を設定する.
`void`	`writeXML(PFXMLGenerator out)` コンポーネントのXML出力.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - FUNCTION_CALL
```
public static final int FUNCTION_CALL
```
    関数呼び出しイベント番号
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - PFFunction
```
public PFFunction()
```
    コンストラクタ
- メソッドの詳細
  - getComponentName
```
public java.lang.String getComponentName()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
  - getComponentKey
```
public java.lang.String getComponentKey()
```
    コンポーネントキーを取得する。
    
    定義:
    
    getComponentKey インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントキー
  - setComponentKey
```
public void setComponentKey(java.lang.String key)
```
    コンポーネントキーを設定する。
    
    定義:
    
    setComponentKey インタフェース内 PFComponent
    
    パラメータ:
    
    key - コンポーネントキー
  - getComponentKeys
```
public PFMultiLocaleString getComponentKeys()
```
    全ロケール分のコンポーネントキーを返す。
    
    戻り値:
    
    全ロケール分のコンポーネントキー
  - setComponentKeys
```
public void setComponentKeys(PFMultiLocaleString keys)
```
    全ロケール分のコンポーネントキーを設定する。
    
    パラメータ:
    
    keys - 全ロケール分のコンポーネントキー
  - getComponentID
```
public int getComponentID()
```
    コンポーネントIDを取得する。
    
    定義:
    
    getComponentID インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネントID
  - setComponentID
```
public void setComponentID(int id)
```
    コンポーネントIDを設定する。
    コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。
    
    定義:
    
    setComponentID インタフェース内 PFComponent
    
    パラメータ:
    
    id - 設定するコンポーネントID
  - getComponentString
```
public java.lang.String getComponentString()
```
    コンポーネントの文字列表現を取得する。
    形式："Component Name" [ ID : "ID" ]
    
    定義:
    
    getComponentString インタフェース内 PFComponent
    
    戻り値:
    
    文字列表現
  - getComponentPublicName
```
public java.lang.String getComponentPublicName()
```
    コンポーネント公開名を取得する.
    
    定義:
    
    getComponentPublicName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント公開名
  - setComponentPublicName
```
public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
```
    コンポーネント公開名を設定する.
    空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。また、既存コンポーネントとの重複も認めない.
    
    定義:
    
    setComponentPublicName インタフェース内 PFComponent
    
    パラメータ:
    
    publicName - 設定するコンポーネント公開名
    
    例外:
    
    PFComponentException - 規約に反する名前が設定されようとした場合
  - isAllowRemoteInvocation
```
public boolean isAllowRemoteInvocation()
```
    他PFからのコンポーネント連携要求に対する可否属性を取得する.
    
    定義:
    
    isAllowRemoteInvocation インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント連携要求可否属性
  - setAllowRemoteInvocation
```
public void setAllowRemoteInvocation(boolean flag)
```
    他PFからのコンポーネント連携要求に対する可否属性を設定する.
    
    定義:
    
    setAllowRemoteInvocation インタフェース内 PFComponent
    
    パラメータ:
    
    flag - コンポーネント連携要求に対する可否
  - isAllowPullTransfer
```
public boolean isAllowPullTransfer()
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPullTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Pull型コンポーネント転送要求可否属性
  - setAllowPullTransfer
```
public void setAllowPullTransfer(boolean flag)
```
    他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPullTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Pull型コンポーネント転送要求に対する可否
  - isAllowPushTransfer
```
public boolean isAllowPushTransfer()
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
    
    定義:
    
    isAllowPushTransfer インタフェース内 PFComponent
    
    戻り値:
    
    Push型コンポーネント転送要求可否属性
  - setAllowPushTransfer
```
public void setAllowPushTransfer(boolean flag)
```
    他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
    
    定義:
    
    setAllowPushTransfer インタフェース内 PFComponent
    
    パラメータ:
    
    flag - Push型コンポーネント転送要求に対する可否
  - getPFProcessRequestListenerList
```
public java.util.Iterator getPFProcessRequestListenerList()
```
    処理要求イベントリスナ配列を取得する。
    
    定義:
    
    getPFProcessRequestListenerList インタフェース内 PFProcessRequestEventSource
    
    戻り値:
    
    イベントリスナイテレータ
  - addPFProcessRequestListener
```
public void addPFProcessRequestListener(PFProcessRequestListener lis)
```
    引数で与えられたイベントリスナを登録し、処理要求イベント発生時に処理を行う対象とする。
    
    定義:
    
    addPFProcessRequestListener インタフェース内 PFProcessRequestEventSource
    
    パラメータ:
    
    lis - 追加対象イベントリスナ
  - removePFProcessRequestListener
```
public void removePFProcessRequestListener(PFProcessRequestListener lis)
```
    引数で与えられたイベントリスナを削除し、処理要求イベント発生時に処理を行う対象から外す。
    
    定義:
    
    removePFProcessRequestListener インタフェース内 PFProcessRequestEventSource
    
    パラメータ:
    
    lis - 削除対象イベントリスナ
  - localeUpdated
```
public void localeUpdated()
```
    ロケール変更に対応する。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
  - call
```
public java.lang.Object call()
                      throws PFSystemException
```
    引数０の関数を呼び出す。
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1)
                      throws PFSystemException
```
    引数１の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2)
                      throws PFSystemException
```
    引数２の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3)
                      throws PFSystemException
```
    引数３の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4)
                      throws PFSystemException
```
    引数４の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    arg4 - 第四引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5)
                      throws PFSystemException
```
    引数５の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    arg4 - 第四引数
    
    arg5 - 第五引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6)
                      throws PFSystemException
```
    引数６の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    arg4 - 第四引数
    
    arg5 - 第五引数
    
    arg6 - 第六引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6,
                             java.lang.Object arg7)
                      throws PFSystemException
```
    引数７の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    arg4 - 第四引数
    
    arg5 - 第五引数
    
    arg6 - 第六引数
    
    arg7 - 第七引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6,
                             java.lang.Object arg7,
                             java.lang.Object arg8)
                      throws PFSystemException
```
    引数８の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    arg4 - 第四引数
    
    arg5 - 第五引数
    
    arg6 - 第六引数
    
    arg7 - 第七引数
    
    arg8 - 第八引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - call
```
public java.lang.Object call(java.lang.Object arg1,
                             java.lang.Object arg2,
                             java.lang.Object arg3,
                             java.lang.Object arg4,
                             java.lang.Object arg5,
                             java.lang.Object arg6,
                             java.lang.Object arg7,
                             java.lang.Object arg8,
                             java.lang.Object arg9)
                      throws PFSystemException
```
    引数９の関数を呼び出す。
    
    パラメータ:
    
    arg1 - 第一引数
    
    arg2 - 第二引数
    
    arg3 - 第三引数
    
    arg4 - 第四引数
    
    arg5 - 第五引数
    
    arg6 - 第六引数
    
    arg7 - 第七引数
    
    arg8 - 第八引数
    
    arg9 - 第九引数
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - callWithList
```
public java.lang.Object callWithList(PFObjectList args)
                              throws PFSystemException
```
    引数をリストとして与えて関数を呼び出す。
    
    パラメータ:
    
    args - 引数リスト
    
    戻り値:
    
    関数戻り値
    
    例外:
    
    PFSystemException
  - getFirstArgument
```
public java.lang.Object getFirstArgument()
```
    第一引数を取得する。
    
    戻り値:
    
    第一引数
  - getSecondArgument
```
public java.lang.Object getSecondArgument()
```
    第二引数を取得する。
    
    戻り値:
    
    第二引数
  - getThirdArgument
```
public java.lang.Object getThirdArgument()
```
    第三引数を取得する。
    
    戻り値:
    
    第三引数
  - getFourthArgument
```
public java.lang.Object getFourthArgument()
```
    第四引数を取得する。
    
    戻り値:
    
    第四引数
  - getFifthArgument
```
public java.lang.Object getFifthArgument()
```
    第五引数を取得する。
    
    戻り値:
    
    第五引数
  - getSixthArgument
```
public java.lang.Object getSixthArgument()
```
    第六引数を取得する。
    
    戻り値:
    
    第六引数
  - getSeventhArgument
```
public java.lang.Object getSeventhArgument()
```
    第七引数を取得する。
    
    戻り値:
    
    第七引数
  - getEighthArgument
```
public java.lang.Object getEighthArgument()
```
    第八引数を取得する。
    
    戻り値:
    
    第七引数
  - getNinthArgument
```
public java.lang.Object getNinthArgument()
```
    第九引数を取得する。
    
    戻り値:
    
    第九引数
  - getArgument
```
public java.lang.Object getArgument(int index)
```
    インデックスを指定して引数を取得する（第一引数のインデックスは0）。
    
    パラメータ:
    
    index - 引数のインデックス
    
    戻り値:
    
    引数
  - getArgumentList
```
public PFObjectList getArgumentList()
```
    引数リストを取得する。
    
    戻り値:
    
    引数リスト
  - clearAllArguments
```
public void clearAllArguments()
```
    すべての引数をクリアする。
  - addArgument
```
public void addArgument(java.lang.Object arg)
```
    引数を追加する。
    
    パラメータ:
    
    arg - 追加する引数
  - callWithCurrentArguments
```
public java.lang.Object callWithCurrentArguments()
                                          throws PFSystemException
```
    現在設定されている引数で処理を呼び出す。
    
    戻り値:
    
    処理実行結果
    
    例外:
    
    PFSystemException
  - countArguments
```
public int countArguments()
```
    引数の数を取得する。
    
    戻り値:
    
    引数の数
  - readXML
```
public void readXML(PFXMLLoader in)
```
    コンポーネントのXML入力.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    コンポーネントのXML出力.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException

クラス PFFunction

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

FUNCTION_CALL

コンストラクタの詳細

PFFunction

メソッドの詳細

getComponentName

getComponentKey

setComponentKey

getComponentKeys

setComponentKeys

getComponentID

setComponentID

getComponentString

getComponentPublicName

setComponentPublicName

isAllowRemoteInvocation

setAllowRemoteInvocation

isAllowPullTransfer

setAllowPullTransfer

isAllowPushTransfer

setAllowPushTransfer

getPFProcessRequestListenerList

addPFProcessRequestListener

removePFProcessRequestListener

localeUpdated

call

call

call

call

call

call

call

call

call

call

callWithList

getFirstArgument

getSecondArgument

getThirdArgument

getFourthArgument

getFifthArgument

getSixthArgument

getSeventhArgument

getEighthArgument

getNinthArgument

getArgument

getArgumentList

clearAllArguments

addArgument

callWithCurrentArguments

countArguments

readXML

writeXML