BEA ホーム | 製品 | デベロッパ・センタ | support | askBEA
 ドキュメントのダウンロード   サイト マップ   用語集 
検索

BPM プラグイン プログラミング ガイド

 前 次 目次 索引 PDFで表示  

プラグイン値オブジェクトのまとめ

この付録では、BPM プラグイン値(すなわち Info)オブジェクトとそのメソッドについて説明します。この付録の内容は以下のとおりです。

値オブジェクト情報の定義方法とアクセス方法の詳細については、プラグイン値オブジェクトの使い方を参照してください。

 


ActionCategoryInfo オブジェクト

com.bea.wlpi.common.plugin.ActionCategoryInfo オブジェクトは、プラグイン アクションまたはアクション カテゴリ情報を管理します。

ActionCategoryInfo は、次のオブジェクトの抽象基本クラスです。

ActionCategoryInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい ActionCategoryInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public ActionCategoryInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
int parentSystemID,
java.lang.String[] classNames
)

次の表に、ActionCategoryInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-1 ActionCategoryInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

アクションまたはアクション カテゴリ ID

ID

public int getID()

アクションまたはアクション カテゴリのローカライズされた名前

name

public java.lang.String getName()

アクションまたはアクション カテゴリのローカライズされた説明

description

public java.lang.String getDescription()

アクション ツリーでアクション カテゴリを識別する親カテゴリの ID。

この ID は次のいずれかの値に設定できる。

親システム ID に対するアクセス権を持たない新しいアクション カテゴリには、必ず ID_NEW を使用する。たとえば、次のカテゴリを追加する場合は、ID_NEW を使用する必要がある。

プラグインが親カテゴリを識別した後は、getSystemID() メソッドによりそのシステム ID を取得できる。

parentSystemID

public int getParentSystemID()

関係するプラグイン クラスを識別する配列。サブクラスにより提供される KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.ActionCategoryInfo Javadoc を参照してください。

 


ActionInfo オブジェクト

com.bea.wlpi.common.plugin.ActionInfo オブジェクトは、プラグイン アクション情報を管理します。

ActionCategoryInfo は、ActionInfo オブジェクトの抽象基本クラスです。

ActionInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい ActionInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public ActionInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
byte[] iconByteArray,
int parentSystemID,
int actionStateMask,
int actionStateTrans,
java.lang.String[] subActionLabels,
java.lang.String[] classNames
)
public ActionInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
byte[] iconByteArray,
int parentSystemID,
int actionStateMask,
java.lang.String[] classNames
)

次の表に、ActionInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-2 ActionInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

アクション ID

ID

public int getID()

アクションのローカライズされた名前

name

public java.lang.String getName()

アクションのローカライズされた説明

description

public java.lang.String getDescription()

このプラグインのためのグラフィカル イメージ(アイコン)のバイト配列表現。インタフェース ビューが有効な場合に、このアクションを表すために Studio により使用される。

バイト配列表現の生成方法の詳細については、InfoObject オブジェクトを参照。

iconByteArray

public javax.swing.Icon getIcon()

public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

アクション ツリーでアクション カテゴリを識別する親カテゴリの ID。

この ID は次のいずれかの値に設定できる。

親システム ID に対するアクセス権を持たない新しいアクション カテゴリには、必ず ID_NEW を使用する。たとえば、次のカテゴリを追加する場合は、ID_NEW を使用する必要がある。

プラグインが親カテゴリを識別した後は、getSystemID() メソッドによりそのシステム ID を取得できる。

parentSystemID

public int getParentSystemID()

このアクションが有効であるアクション ステートを示すビット マスク。

この値は、指定された値のビット演算子 OR を実行することにより作成される。

ビット マスクは、アクションが有効なときを指定する次の値の 1 つまたは複数に設定できる。

actionStateMask

public boolean isValidActionState (int actionStateMask)

アクションのサブアクションの実行に起因するアクション ステート遷移。

この ステート は次のいずれかの値に設定できる。

actionStateTrans

public int getActionStateTrans()

ローカライズされたアクション リスト ラベル。

subActionLabels

public java.lang.String[] getSubActionLabels()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.Object getClass(int key)


 

詳細については、com.bea.wlpi.common.plugin.ActionInfo Javadoc を参照してください。

 


CategoryInfo オブジェクト

com.bea.wlpi.common.plugin.CategoryInfo オブジェクトは、プラグイン アクション カテゴリに関する情報を管理します。

ActionCategoryInfo は、CategoryInfo オブジェクトの抽象基本クラスです。

The CategoryInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい CategoryInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public CategoryInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
int parentSystemID,
com.bea.wlpi.common.plugin.ActionCategoryInfo[] subNodes
)

次の表に、CategoryInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-3 CategoryInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

set メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

なし

アクション カテゴリ ID

ID

public int getID()

なし

アクション カテゴリのローカライズされた名前

name

public java.lang.String getName()

なし

アクション カテゴリのローカライズされた説明

description

public java.lang.String getDescription()

なし

アクション ツリーでカテゴリを識別する親カテゴリの ID

この ID は次のいずれかの値に設定できる。

親システム ID に対するアクセス権を持たない新しいアクション カテゴリには、必ず ID_NEW を使用する。たとえば、次のカテゴリを追加する場合は、ID_NEW を使用する必要がある。

プラグインが親カテゴリを識別した後は、getSystemID() メソッドによりそのシステム ID を取得できる。

parentSystemID

public int getParentSystemID()

なし

関係するプラグイン クラスを識別する配列。サブクラスにより提供される KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

subNodes

public com.bea.wlpi.common.plugin.
ActionCategoryInfo[] getSubnodes()

public void addSubNode(com.bea.wlpi.common.plugin.
ActionCategoryInfo
node)

プラグイン システム ID

なし

public int getSystemID()

public int setSystemID(int systemID)


 

注意: 前の表で定義したメソッドの他に、次のメソッドがアクション カテゴリとそのサブカテゴリを再帰的に検索し、システム ID の一致するカテゴリを探します。

詳細については、com.bea.wlpi.common.plugin.CategoryInfo Javadoc を参照してください。

 


ConfigurationData オブジェクト

com.bea.wlpi.common.plugin.ConfigurationData オブジェクトは、プラグイン コンフィグレーション情報を管理します。

新しい ConfigurationData オブジェクトを作成するには、次のコンストラクタを使用します。

public ConfigurationData(
java.lang.String pluginName,
com.bea.wlpi.common.VersionInfo version,
int status,
int startMode,
java.lang.String xml
)

次の表に、ConfigurationData オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-4 ConfigurationData オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン バージョン

version

public com.bea.wlpi.common.VersionInfo getVersion()

プラグイン ステータス

status

public int getStatus()

プラグイン起動モード

startMode

public int getStartMode()

XML コンフィグレーション ドキュメント

xml

public java.lang.String getXML()


 

詳細については、com.bea.wlpi.common.plugin.ConfigurationData Javadoc を参照してください。

 


ConfigurationInfo オブジェクト

com.bea.wlpi.common.plugin.ConfigurationInfo オブジェクトは、プラグイン コンフィグレーション情報を管理します。

ConfigurationInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい ConfigurationInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public ConfigurationInfo(
java.lang.String pluginName,
int ID,
java.lang.String description,
java.lang.String[] classNames
)

次の表に、ConfigurationInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-5 ConfigurationInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

プラグインの説明

description

public int getStatus()

プラグイン起動モード

startMode

public int getStartMode()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.ConfigurationInfo Javadoc を参照してください。

 


DoneInfo オブジェクト

com.bea.wlpi.common.plugin.DoneInfo オブジェクトは、プラグイン完了ノードに関する情報を管理します。

DoneInfo クラスは、次のクラスを拡張します。

新しい DoneInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public DoneInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
byte[] iconByteArray,
java.lang.String[] classNames
)

次の表に、DoneInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-6 DoneInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

完了ノードのローカライズされた名前

name

public java.lang.String getName()

完了ノードのローカライズされた説明

description

public java.lang.String getDescription()

このプラグインのためのグラフィカル イメージ(アイコン)のバイト配列表現。インタフェース ビューが有効な場合に、このアクションを表すために Studio により使用される。

バイト配列表現の生成方法の詳細については、InfoObject オブジェクトを参照。

iconByteArray

public javax.swing.Icon getIcon()

public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.DoneInfo Javadoc を参照してください。

 


EventHandlerInfo オブジェクト

com.bea.wlpi.common.plugin.EventHandlerInfo オブジェクトは、プラグイン イベント ハンドラに関する情報を管理します。

EventHandlerInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい EventHandlerInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public EventHandlerInfo(
java.lang.String pluginName,
java.lang.String name,
java.lang.String description,
java.lang.String[] classNames
)

次の表に、EventHandlerInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-7 EventHandlerInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

イベント ハンドラのローカライズされた名前

name

public java.lang.String getName()

イベント ハンドラのローカライズされた説明

description

public java.lang.String getDescription()

関係するプラグイン クラスを識別する配列。次の KEY_* 値について 1 つのエントリ(Java クラスの完全修飾名)が入る。

KEY_HANDLERcom.bea.wlpi.server.plugin.EventHandler 実装クラス名を示すキー値。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.EventHandlerInfo Javadoc を参照してください。

 


EventInfo オブジェクト

com.bea.wlpi.common.plugin.EventInfo オブジェクトは、プラグイン イベント ハンドラに関する情報を管理します。

EventInfo クラスは、次のクラスを拡張します。

新しい EventInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public EventInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
byte[] iconByteArray,
java.lang.String[] classNames,
com.bea.wlpi.common.plugin.FieldInfo fieldInfo
)

次の表に、EventInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-8 EventInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

イベントのローカライズされた名前

name

public java.lang.String getName()

イベントのローカライズされた説明

description

public java.lang.String getDescription()

このプラグインのためのグラフィカル イメージ(アイコン)のバイト配列表現。インタフェース ビューが有効な場合に、このアクションを表すために Studio により使用される。

バイト配列表現の生成方法の詳細については、InfoObject オブジェクトを参照。

iconByteArray

public javax.swing.Icon getIcon()


public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)

プラグイン フィールド情報

fieldInfo

public com.bea.wlpi.common.plugin.FieldInfo getFieldInfo()


 

詳細については、com.bea.wlpi.common.plugin.EventInfo Javadoc を参照してください。

 


FieldInfo オブジェクト

com.bea.wlpi.common.plugin.FieldInfo オブジェクトは、プラグイン フィールドに関する情報を管理します。

FieldInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい FieldInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public FieldInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
java.lang.String[] classNames,
boolean supportsQualifiers
)

次の表に、FieldInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-9 FieldInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

フィールドのローカライズされた名前

name

public java.lang.String getName()

フィールドのローカライズされた説明

description

public java.lang.String getDescription()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)

フィールド タイプがドット区切りの名前をサポートするかどうかを示すフラグ。たとえば、PostalCode フィールドが Address フィールドに埋め込まれている場合、そのフィールドの名前は Address.PostalCode となる。

式エバリュエータは、プラグインの 開始、イベント、または イベント キーの式でフィールド参照が有効であるかどうかを調べるためにこのフラグを使用する。

supportsQualifiers

public boolean supportsQualifiers()


 

詳細については、com.bea.wlpi.common.plugin.FieldInfo Javadoc を参照してください。

 


FunctionInfo オブジェクト

com.bea.wlpi.common.plugin.FunctionInfo オブジェクトは、プラグイン関数に関する情報を管理します。

FunctionInfo クラスは、InfoObject オブジェクトに説明されているように com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい FunctionInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public FunctionInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
java.lang.String prototype,
java.lang.String[] classNames,
int argcmin,
int argcmax
)

次の表に、FunctionInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-10 FunctionInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

関数のローカライズされた名前

name

public java.lang.String getName()

関数のローカライズされた説明

description

public java.lang.String getDescription()

この関数のローカライズされたプロトタイプ

prototype

public java.lang.String prototype()

関係するプラグイン クラスを識別する配列。次の KEY_* 値について 1 つのエントリ(Java クラスの完全修飾名)が入る。

KEY_EVALUATORcom.bea.wlpi.common.plugin.PluginFunction 実装クラス名を示すキー値。

classNames

public java.lang.String getClassName(int key)

許される引数の最小数。式エバリュエータは、この関数に対するコールを検証するためにこの情報を使用する。

argcmin

public int getMinArgCount()

許される引数の最大数。式エバリュエータは、この関数に対するコールを検証するためにこの情報を使用する。

argcmax

public int getMaxArgCount()


 

詳細については、com.bea.wlpi.common.plugin.FunctionInfo Javadoc を参照してください。

 


HelpSetInfo オブジェクト

com.bea.wlpi.common.plugin.HelpSetInfo オブジェクトは、プラグイン オンライン ヘルプに関する情報を管理します。プラグインは、HTML および JavaHelp の両方のオンライン ヘルプ システムをサポートできます。プラグイン オンライン ヘルプ ファイルは、WAR ファイルにパッケージ化し、プロセス エンジンの一部としてデプロイする必要があります。BPM クライアント アプリケーションが適切なヘルプ ファイルを取得できるようにするため、オンライン ヘルプ WAR ファイルは、それが関係するプラグインの名前の下でデプロイする必要があります。

BPM クライアント アプリケーションは、Plug-in Manager (または他の EJB)の ClassLoader を使用して、プロセス エンジンの URL を確認できます。クライアント アプリケーションは、HelpSetInfo オブジェクト値を使用して、http または https を介してヘルプ ファイルにアクセスするための完全な URL を取得できます。

HelpSetInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい HelpSetInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public HelpSetInfo(
java.lang.String pluginName,
java.lang.String name,
java.lang.String description,
java.lang.String[] helpNames,
int helpType
)

次の表に、HelpSetInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-11 HelpSetInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

オンライン ヘルプ セットを提供するプラグイン名(逆引き DNS バージョン)。

BPM クライアント アプリケーションがヘルプ セットの正しい URL を作成するためには、この名前は、WAR ファイルをデプロイする Web アプリケーション と一致している必要があります。

pluginName

public java.lang.String getPluginName()

オンライン ヘルプのローカライズされた名前。

この値は、コンテキスト依存でないヘルプにアクセスするために使用されるユーザ インタフェース メニュー オプションのラベル値として使用される。

name

public java.lang.String getName()

オンライン ヘルプのローカライズされた説明

description

public java.lang.String getDescription()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

各エントリの値は、ヘルプ タイプおよび関係するプラグイン クラスの表に定義されているように、helpType パラメータの値に従って解釈される。

helpNames

public java.lang.String getClassName(int key)

プラグインにより提供されるヘルプのタイプ。次のいずれかの値に設定できる。

各エントリの値は、ヘルプ タイプおよび関係するプラグイン クラスの表に定義されているように、helpNames パラメータの値に従って解釈される。

helpType

public int getHelpType()


 

次の表に、ヘルプ タイプ(helpType 値)および関係するプラグイン クラス(helpNames 値)を示します。

表 B-12 ヘルプ タイプおよび関係するプラグイン クラス

helpType 値

helpNames 値

KEY_HELP_SET

KEY_HELP_ID

HELP_JAVA_HELP

JavaHelp セット ファイルの名前。ヘルプ ファイルの入っている WAR ファイルのルートに対する相対値(たとえば、javahelp/MyPluginHelpSet.hs)。拡張子がない場合、JavaHelp により自動的に hs 拡張子が追加される。

メイン インデックス ページまたは目次のための JavaHelp ヘルプ キー。

HELP_HTML

HTML ヘルプ ファイルのルート ディレクトリの名前。末尾に必ずスラッシュを付ける(たとえば、htmlhelp/)。

メイン インデックス ページまたは目次の入っている HTML ファイルの名前(必須の .htm 拡張子を含まない)。KEY_HELP_SET エントリにより指定されるディレクトリに対する相対値。


 

詳細については、com.bea.wlpi.common.plugin.HelpSetInfo Javadoc を参照してください。

 


InfoObject オブジェクト

com.bea.wlpi.common.plugin.InfoObject オブジェクトは、すべてのプラグイン値オブジェクトのための抽象基本クラスを提供します。

新しい InfoObject オブジェクトを作成するには、次のコンストラクタを使用します。

public InfoObject(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
java.lang.String[] classNames
)

次の表に、InfoObject オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-13 InfoObject オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

オブジェクトのローカライズされた名前

name

public java.lang.String getName()

オブジェクトのローカライズされた説明

description

public java.lang.String getDescription()

関係するプラグイン クラスを識別する配列。サブクラスにより提供される KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

また、InfoObject オブジェクトは、ActionInfoDoneInfoEventInfoStartInfo、および TemplateDefinitionPropertiesInfo の各オブジェクトをコンストラクトする際に使用できる iconByteArray 値を入力ストリームから生成するための次のメソッドも提供します。

public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

詳細については、com.bea.wlpi.common.plugin.InfoObject Javadoc を参照してください。

 


PluginCapabilitiesInfo オブジェクト

com.bea.wlpi.common.plugin.PluginCapabilitiesInfo オブジェクトは、プラグイン機能に関する情報を管理します。

PluginCapabilitiesInfo オブジェクトは、プラグインがロードされた後、プラグイン機能の完全なセットの説明を提供します。ロード前でも、PluginInfo オブジェクトに説明されているように、com.bea.wlpi.common.plugin.PluginInfo オブジェクトを使用して基本プラグイン情報にアクセスできます。

新しい PluginCapabilitiesInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public PluginCapabilitiesInfo(
com.bea.wlpi.common.plugin.PluginInfo info,
com.bea.wlpi.common.plugin.ActionCategoryInfo[] actions,
com.bea.wlpi.common.plugin.EventInfo[] events,
com.bea.wlpi.common.plugin.FieldInfo[] fields,
com.bea.wlpi.common.plugin.FunctionInfo[] functions,
com.bea.wlpi.common.plugin.StartInfo[] starts,
com.bea.wlpi.common.plugin.DoneInfo[] dones,
com.bea.wlpi.common.plugin.VariableTypeInfo[] variableTypes,
com.bea.wlpi.common.plugin.TemplatePropertiesInfo[] template,
com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo[]
templateDefinition,
com.bea.wlpi.common.plugin.EventHandlerInfo eventHandler
)

次の表に、PluginCapabilitiesInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-14 PluginCapabilitiesInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

基本プラグイン情報

info

public java.lang.String getPluginInfo()

プラグインにより提供されるアクションとアクション カテゴリ

actions

public com.bea.wlpi.common.plugin.ActionCategoryInfo[] getActionInfo()

プラグインにより提供されるイベント

events

public com.bea.wlpi.common.plugin.EventInfo[] getEventInfo()

プラグインにより提供されるフィールド

fields

public com.bea.wlpi.common.plugin.FieldInfo[] getFieldInfo()

プラグインにより提供される関数

functions

public com.bea.wlpi.common.plugin.FunctionInfo[] getFunctionInfo()

プラグインにより提供される開始ノード

starts

public com.bea.wlpi.common.plugin.StartInfo[] getStartInfo()

プラグインにより提供される完了ノード

dones

public com.bea.wlpi.common.plugin.DoneInfo[] getDoneInfo()

プラグインにより提供される変数

variableTypes

public com.bea.wlpi.common.plugin.VariableTypesInfo[] getVariableTypesInfo()

プラグインにより提供されるワークフロー テンプレート プロパティ

template

public com.bea.wlpi.common.plugin.TemplatePropertiesInfo[] getTemplateInfo()

プラグインにより提供されるワークフロー テンプレート定義プロパティ

templateDefinition

public com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo[] getTemplateDefinitionInfo()

イベント ハンドラ情報

eventHandler

public com.bea.wlpi.common.plugin.EventHandlerInfo getEventHandlerInfo()


 

詳細については、com.bea.wlpi.common.plugin.PluginCapabilitiesInfo Javadoc を参照してください。

 


PluginDependency オブジェクトt

com.bea.wlpi.common.plugin.PluginDependency オブジェクトは、プラグイン依存関係に関する情報を管理します。

PluginDependency クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい PluginDependency オブジェクトを作成するには、次のコンストラクタを使用します。

public PluginDependency(
java.lang.String pluginName,
java.lang.String description,
java.lang.String masterPluginName,
java.lang.String vendor,
com.bea.wlpi.common.VersionInfo version
)

次の表に、PluginDependency オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-15 PluginDependency オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

オブジェクトのローカライズされた説明

description

public java.lang.String getDescription()

マスター プラグイン名(逆引き DNS バージョン)

masterPluginName

public java.lang.String getMasterPluginName()

マスター プラグイン ベンダ名

vendor

public java.lang.String getVendor()

マスター プラグイン バージョン

version

public com.bea.wlpi.common.VersionInfo getVersion()


 

詳細については、com.bea.wlpi.common.plugin.PluginDependency Javadoc を参照してください。

 


PluginInfo オブジェクト

com.bea.wlpi.common.plugin.PluginInfo オブジェクトは、プラグインに関する基本情報を管理します。

PluginInfo オブジェクトは、プラグインがロードされる前に、プラグイン機能の基本セットの説明を提供します。ロード後は、PluginCapabilitiesInfo オブジェクトに説明されているように、com.bea.wlpi.common.plugin.PluginCapabilitiesInfo オブジェクトを使用して基本プラグイン情報にアクセスできます。

PluginInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい PluginInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public PluginInfo(
java.lang.String pluginName,
java.lang.String name,
java.util.Locale lc,
java.lang.String vendor,
java.lang.String url,
com.bea.wlpi.common.VersionInfo version,
com.bea.wlpi.common.VersionInfo pluginFrameworkVersion,
com.bea.wlpi.common.plugin.PluginDependency[] dependencies,
com.bea.wlpi.common.plugin.ConfigurationInfo config,
com.bea.wlpi.common.plugin.HelpSetInfo helpSet
)

次の表に、PluginInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-16 PluginInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

オブジェクトのローカライズされた名前

name

public java.lang.String getName()

表示文字列をローカライズするためのロケール

lc

public java.lang.String getLocale()

プラグイン ベンダの名前

vendor

public java.lang.String getVendor()

プラグイン ベンダの URL

url

public java.lang.String getURL()

プラグイン バージョン

version

public com.bea.wlpi.common.VersionInfo getVersion()

プラグイン フレームワーク バージョン

pluginFrameworkVersion

public com.bea.wlpi.common.VersionInfo getPluginFrameworkVersion()

プラグイン依存関係

dependencies

public com.bea.wlpi.common.plugin.PluginDependency[] getDependencyInfo()

プラグイン コンフィグレーション情報

config

public com.bea.wlpi.common.plugin.ConfigurationInfo getConfigurationInfo()

プラグインにより提供される JavaHelp ヘルプ セット

helpSet

public com.bea.wlpi.common.plugin.HelpSetInfo getHelpSetInfo()


 

詳細については、com.bea.wlpi.common.plugin.PluginInfo Javadoc を参照してください。

 


StartInfo オブジェクト

com.bea.wlpi.common.plugin.StartInfo オブジェクトは、プラグイン開始ノードに関する情報を管理します。

StartInfo クラスは、次のクラスを拡張します。

新しい StartInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public StartInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
byte[] iconByteArray,
java.lang.String[] classNames,
com.bea.wlpi.common.plugin.FieldInfo fieldInfo
)

次の表に、StartInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-17 StartInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

開始ノードのローカライズされた名前

name

public java.lang.String getName()

開始ノードのローカライズされた説明

description

public java.lang.String getDescription()

このプラグインのためのグラフィカル イメージ(アイコン)のバイト配列表現。インタフェース ビューが有効な場合に、このアクションを表すために Studio により使用される。

バイト配列表現の生成方法の詳細については、InfoObject オブジェクトを参照。

iconByteArray

public javax.swing.Icon getIcon()

public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)

プラグイン フィールド情報

fieldInfo

public com.bea.wlpi.common.plugin.FieldInfo getFieldInfo()


 

詳細については、com.bea.wlpi.common.plugin.StartInfo Javadoc を参照してください。

 


TemplateDefinitionPropertiesInfo オブジェクト

com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo オブジェクトは、プラグイン テンプレート定義プロパティに関する情報を管理します。

TemplateDefinitionPropertiesInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい TemplateDefinitionPropertiesInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public DoneInfo(
java.lang.String pluginName,
java.lang.String name,
java.lang.String description,
java.lang.String[] classNames
)

次の表に、TemplateDefinitionPropertiesInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-18 TemplateDefinitionPropertiesInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

オブジェクトのローカライズされた名前。

この文字列は、[テンプレート定義のプロパティ] ダイアログ ボックスの [プラグイン] タブの内容を定義する。

name

public java.lang.String getName()

オブジェクトのローカライズされた説明

description

public java.lang.String getDescription()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.TemplateDefinitionPropertiesInfo Javadoc を参照してください。

 


TemplateNodeInfo オブジェクト

com.bea.wlpi.common.plugin.TemplateNodeInfo オブジェクトは、プラグイン テンプレート定義ノードに関する情報を管理します。

TemplateNodeInfo は、次のクラスにより拡張されます。

TemplateNodeInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい TemplateNodeInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public TemplateNodeInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
byte[] iconByteArray,
java.lang.String[] classNames
)

次の表に、TemplateNodeInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-19 TemplateNodeInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

テンプレート定義ノードのローカライズされた名前

name

public java.lang.String getName()

テンプレート定義ノードのローカライズされた説明

description

public java.lang.String getDescription()

このプラグインのためのグラフィカル イメージ(アイコン)のバイト配列表現。インタフェース ビューが有効な場合に、このアクションを表すために Studio により使用される。

バイト配列表現の生成方法の詳細については、InfoObject オブジェクトを参照。

iconByteArray

public javax.swing.Icon getIcon()

public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException

関係するプラグイン クラスを識別する配列。対応するサブクラスのために定義される KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.TemplateNodeInfo Javadoc を参照してください。

 


TemplatePropertiesInfo オブジェクト

com.bea.wlpi.common.plugin.TemplatePropertiesInfo オブジェクトは、プラグイン テンプレート プロパティに関する情報を管理します。

TemplatePropertiesInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい TemplatePropertiesInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public TemplatePropertiesInfo(
java.lang.String pluginName,
java.lang.String name,
java.lang.String description,
java.lang.String[] classNames
)

次の表に、TemplatePropertiesInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-20 TemplatePropertiesInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

オブジェクトのローカライズされた名前。

この文字列は、[テンプレート プロパティ] ダイアログ ボックスの [プラグイン] タブの内容を定義する。

name

public java.lang.String getName()

オブジェクトのローカライズされた説明

description

public java.lang.String getDescription()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.TemplatePropertiesInfo Javadoc を参照してください。

 


VariableTypeInfo オブジェクト

com.bea.wlpi.common.plugin.VariableTypeInfo オブジェクトは、プラグイン変数に関する情報を管理します。

VariableTypeInfo クラスは、InfoObject オブジェクトに説明されているように、com.bea.wlpi.common.plugin.InfoObject クラスを拡張します。

新しい VariableTypeInfo オブジェクトを作成するには、次のコンストラクタを使用します。

public VariableTypeInfo(
java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
int variableType,
java.lang.Class valueClass,
java.lang.String[] classNames
)

次の表に、VariableTypeInfo オブジェクト情報、そのデータを定義する際に使用するコンストラクタ パラメータ、オブジェクト定義後にこの情報にアクセスするために使用できるメソッドを示します。

表 B-21 VariableTypeInfo オブジェクト情報

オブジェクト情報

コンストラクタ パラメータ

get メソッド

プラグイン名(逆引き DNS バージョン)

pluginName

public java.lang.String getPluginName()

プラグイン ID

ID

public int getID()

変数タイプのローカライズされた名前

name

public java.lang.String getName()

変数タイプのローカライズされた説明

description

public java.lang.String getDescription()

変数タイプは次のいずれかの整数値に設定できる。

variableType

public int getVariableType()

許される値タイプの完全修飾 Java クラス

valueClass

public java.lang.Class getValueClass()

関係するプラグイン クラスを識別する配列。次の KEY_* 値のそれぞれについて 1 つのエントリ(Java クラスの完全修飾名)が入る。

classNames

public java.lang.String getClassName(int key)


 

詳細については、com.bea.wlpi.common.plugin.VariableTypeInfo Javadoc を参照してください。

 

ページの先頭 前 次