プラグイン・スクリプトのAPI

プログラムベース・プラグインと同様に、プラグイン・スクリプトは次のように動作します。

• アプリケーション・サーバー上で実行されます。
• プラグイン・スポットで定義されたAPI(入力/出力インタフェース)を使用します(つまり、プラグイン・スクリプトで独自のAPIは宣言しません)。
• プラグイン・スポット・ドライバによってのみ起動できます。

スクリプト・エンジン・バージョンを使用するように構成されたプラグインについては、「スクリプト・スキーマの表示」ハイパーリンクを使用してパラメータ・データ領域スキーマを表示すると、スクリプトのAPIをよく理解できます。

softとhardの2つのグループがあることに注意してください。プラグイン・スポットをよく理解している場合は、これらが典型的なソフト・パラメータおよびハード・パラメータであることが認識できます。

• ソフト・パラメータは、アルゴリズムで定義されたパラメータの値です。名前が指定されていないことに注意してください。プラグイン・スクリプトでこれらを参照する場合は、位置で参照する必要があります。
• ハード・パラメータはプラグイン・スポット(つまり、アルゴリズム・エンティティ)によって制御されます。このプラグイン・スポットにbusinessObject/idという単一の入力パラメータがあることに注意してください。また、use=属性もあり、これはこのパラメータが入力専用であることを示します(つまり、プラグイン・スクリプトでこの属性を変更できません)。

Groovyエンジン・バージョンを使用するように構成されたプラグインでは、APIのXMLインタフェースを使用せず、かわりにJavaアルゴリズムと同じ方法で処理されます。フレームワークでは、Groovyオブジェクトのプラグイン・スポットを実装する動的に生成されるスーパークラスを提供します。このスーパークラスおよびメソッドを表示してハード・パラメータを設定および取得するには、「スクリプト・スーパークラスの表示」ハイパーリンクを使用します。