v7

SOAP メソッドの実装

最終更新日: 2023-08-31
  • 作成対象:
  • Developer

はじめに

JavaScript で SOAP メソッドを作成できます。 この関数は、単にアプリケーションプロセスを有効にするだけで、フォーム内で JSP を開発したり呼び出したりするのを避けることができます。

これらの SOAP メソッドは、アプリケーションでネイティブに定義されたメソッドと同じように動作します。 同じ属性がサポートされています: static、key only、const。

メソッドライブラリの定義

メソッドライブラリの作成には、次の 2 つのステージが含まれます。

  • SOAP メソッドの宣言
  • JavaScript での定義(または実装)。

宣言

スキーマでメソッドを宣言します ( スキーマの作成および編集方法について詳しくは、 この節) をクリックします。

この宣言はネイティブメソッドの宣言と似ていますが、定義が存在するメソッドライブラリの名前を指定する「library」属性を追加する必要がある点が異なります。

この名前は、「JavaScript コード」タイプのエンティティの名前(名前空間)と一致します。

例:

testLog(msg) メソッドは、 nms:recipient 拡張で宣言します。

<method name="testLog" static="true" library="cus:test">
     <parameters>
       <param name="message" type="string" inout="in"/>
     </parameters>
   </method>
メモ

ライブラリに使用される名前空間と名前は、宣言が見つかる名前空間やスキーマ名とは独立しています。

定義

SOAP メソッドは、ライブラリを表すスクリプトにグループ化された JavaScript 関数の形式で実装されます。

メモ

メソッドライブラリは、様々なスキーマの関数をグループ化できます。また、その逆も可能です。1 つのスキーマの関数は、別々のライブラリで定義できます。

スクリプトには、初回のライブラリ読み込み中に実行されるコードを含めることができます。

1.名前

関数の名前は、次の形式に従う必要があります。

 <schema-namespace>_<schema-name>_<method-name>

例:

次の JavaScript 関数は、上記のメソッドの実装です。 「cus:test」名を使用して、「JavaScript コード」タイプのエンティティで定義する必要があります。

function nms_recipient_testLog(message)
 {
   logInfo("*** " + message)
 }

2.署名

関数のシグネチャには、宣言の各'in'または'inout'パラメータの引数を含める必要があります。

具体的な例:

  • 非静的メソッド:関数は、まず追加の引数を含め、「xml」(E4X) タイプのオブジェクトの形式で渡された XML エンティティと一致させる必要があります。
  • 「キーのみ」タイプメソッド:関数は、最初に、文字列の形式で渡されたキーと一致する、追加の引数を含める必要があります。

3.戻り値

この関数は、「out」型または「inout」型のパラメーターごとに値を返す必要があります。 具体的なケース:メソッドが「static」、「key only」または「const」属性のいずれも指定せずに宣言されている場合、最初の戻り値は変更されたエンティティと一致する必要があります。 新しいオブジェクトを返したり、最初に変更されたパラメータを返したりできます。

例:

function nms_recipient_setLastName(self, name)
 {
   self.@lastName = name
   return self
 }

複数の値が返される場合は、テーブルに表示する必要があります。

例:

function nms_recipient_getKey(self)
 {
   return [self.@firstName, self.@lastName]
 }

このページ