getQueryParameter()

j2eeLib.getQueryParameter() システム関数は、指定されたキーを使用して、要求スコープのストレージから照会パラメーター (通常は AJAX 要求で渡されるパラメーター) を取得します。指定されたキーを使用して値が見つからない場合、関数は NULL 値を返します。

この関数は、j2eeLib.getRequestAttr() などの関数を使用して要求に含める値を取得するために使用することはできません。その代わり、j2eeLib.getQueryParameter() は、以下のいずれかの方法で要求に含める値を取得します。
  • URL の末尾に直接付加される名前と値のペア。以下の例のようになります。
    http://www.ibm.com/mypage.jsp?myparameter=myvalue
    この場合、次のコードで値を取得します。
    myVar1 string = j2eeLib.getQueryParameter("myparameter");
  • AJAX 要求の params 属性に付加されたパラメーター。次の例のようになります。
    <hx:ajaxRefreshRequest id="ajaxRefreshRequest1"
      target="updatablePanel" params="input1;input2;operationComboBox">
    </hx:ajaxRefreshRequest>
    この場合、次のコードで値を取得します。
    myVar2, myVar3, myVar4 string;
    myVar2 = j2eeLib.getQueryParameter("input1");
    myVar3 = j2eeLib.getQueryParameter("input2");
    myVar4 = j2eeLib.getQueryParameter("operationComboBox");
  • AJAX 要求内の <f:param> タグに付加されたパラメーター。次の例のようになります。
    <hx:ajaxRefreshRequest id="ajaxRefreshRequest1"
      target="updatablePanel">
      <f:param name="serverParam" id="param1"
        value="#{myPage.myValue}">
      </f:param>
    </hx:ajaxRefreshRequest>
    この場合、次のコードで値を取得します。
    myVar5 string;
    myVar5 = j2eeLib.getQueryParameter("serverParam");
この関数は $$ajaxmode のキーを受け入れ、サーブレットによって現在処理されている要求が AJAX 要求であるか別のタイプの要求であるかを判別します。
  • 要求が AJAX 要求でない場合、getQueryParameter("$$ajaxmode") は NULL 値を戻します。
  • 要求が AJAX の更新要求の場合、getQueryParameter("$$ajaxmode") は、"axpartial" を戻します。
  • 要求が AJAX 実行要求の場合、getQueryParameter("$$ajaxmode") は、"axfull" を戻します。
  • 要求が AJAX 外部要求の場合、getQueryParameter("$$ajaxmode") は、NULL 値を戻します。
  j2eeLib.getQueryParameter(
    key STRING in)
  returns (value STRING?)
key
STRING 型との代入互換性のある任意の値。 EGL における代入の互換性 を参照してください。
value
STRING。