Ajaxフレームワーク ユーザーズガイド

3.2.6 ビジネスメソッドの実行

JavaScriptでApcoordinatorのビジネスクラスを呼び出すには、UjiRequestオブジェクトのsend関数を使用します。

■UjiRequest.send関数の形式

以下に、UjiRequest.send関数の記述形式を示します。

UjiRequest.send(dataObj, requestParams, option);

• dataObj
  サーバ側に送信するデータのオブジェクトです。
  データを送信しない場合は、nullを指定します。

• requestParams
  コマンド名やデータBean IDなど、Apcoordinatorの動作を制御するための値を格納したリクエストパラメタオブジェクトです。
  リクエストパラメタが不要な場合は、nullを指定します。

  以下に、リクエストパラメタオブジェクトのプロパティを示します。

  プロパティ名	概要	型	省略可否
  beanId	送信データを格納するデータBean ID ApcoordinatorアプリケーションとデータBeanを共有しない場合は、Ajaxフレームワーク環境定義ファイルに定義されたデータBeanの名前を指定します。 ApcoordinatorアプリケーションとデータBeanを共有する場合は、データBeanを関連付けたデータBean IDを指定します。(注)	string	dataObjがnullの場合は省略可 それ以外の場合は省略不可
  verb	コマンド名 コマンドマップで定義されたコマンドと対応します。	string	可

  注) データBean IDにデータBeanを関連付けるには、DispatchContextクラスのsetResponseBeanメソッドを利用します。詳細は、“ApcoordinatorとのデータBeanの共有”を参照してください。beanIdにそのデータBean IDを指定すると、Apcoordinatorが保持するデータBeanにデータが格納されます。
  Apcoordinatorの画面表示の際、<uji:useBean>タグを利用する場合は、request="true"を指定します。request="true"を指定すると、次のリクエストまで、ApcoordinatorがデータBeanを保持します。

• option
  UjiRequestの動作を制御するための値を格納した通信設定オブジェクトです。
  optionにnullが指定された場合、または省略された場合は、通信せずにエラーが発生します。

  以下に、通信設定オブジェクトのプロパティを示します。

  プロパティ名	概要	型	省略可否
  url	通信先のURL “acf/apc”を指定します。サブフォルダに配置されているHTML/JSPファイルからビジネスメソッドを実行する場合、urlプロパティで指定する“acf/apc”について、パスの考慮が必要です。アプリケーションフォルダを基点とした“acf/apc”が参照できるように相対パスで指定してください。例えば、アプリケーションフォルダ直下の“JSP”フォルダにHTML/JSPファイルが存在する場合は、“../acf/apc”を指定してください。HTML/JSPファイルがインクルードされている場合には、インクルード元のHTML/JSPファイルが存在するフォルダを基点とした相対パスで指定してください。 URLには、任意のクエリ文字列やURLリライティングで使用するセションIDを付加することができます。詳細は、“リクエスト送信時のURLについて”を参照してください。	string	不可
  callback	レスポンスハンドラ(正常終了時のコールバック) ビジネスメソッドからの戻り値がある場合は、第1引数に渡されます。voidの場合は、パラメタなしで呼ばれます。	function	不可
  errorHandler	エラーハンドラ(エラー発生時のコールバック) 第1引数にエラーオブジェクトが渡されます。 詳細は、“通信フレームワーク内のエラー”を参照してください。	function	可
  timeout	タイムアウト時間(ミリ秒) サーバからのレスポンスが完了するまでの最大待ち時間です。この時間を超えると、エラーハンドラ呼出しとなります。 省略値は、120000(120秒)です。 なお、0を指定することはできません。	number	可
  preInvoke	メソッド呼出し直前に呼ばれるコールバック 引数はありません。	function	可
  postInvoke	メソッド呼出し完了直後に呼ばれるコールバック 引数はありません。	function	可

  以下に、通信設定オブジェクトのプロパティに関する注意事項を示します。

  • 各種コールバック関数がnullの場合、コールバック呼出しは行われません。
  • プロパティの型がfunctionとなっているものは、JavaScriptの関数を指定します。
    以下に、callbackプロパティにレスポンスハンドラを記述する例を示します。

    var option = {
      ...,
      // サーバからの戻り値を引数に指定
      // 引数の名前は任意
      callback:function(res){
        // サーバからの戻り値に対する処理を記述
        ...;
      }
    };

    
    

■UjiRequest.send関数の記述例

以下に、UjiRequest.send関数の記述例を示します。
以下の例では、Ajaxフレームワーク環境定義ファイルに“databean”の名前を持つIDで対応付けられたデータBeanにデータが格納されます。

function clickExecuteButton() {
    // requestParam
    var reqParam = {
        beanId:'databean',  // データBean IDを指定
        verb:'execute'  // コマンド名を指定
    };
    // option
    var option = {
        url:'acf/apc',
        callback:function(res){
        }
    };
    UjiRequest.send(data,reqParam,option);
}

■UjiRequest.send関数が通知する例外

UjiRequest.send関数が通知する例外については、“通信フレームワーク(JavaScript)に関するメッセージ”を参照してください。