OPRO X Server API

net.opro.product.odcaw.api
クラス TemplateParameter

Object
  拡張net.opro.product.odcaw.api.ParameterImpl
      拡張net.opro.product.odcaw.api.TemplateParameter
すべての実装インタフェース:
net.opro.product.odcaw.api.Parameter

public class TemplateParameter
extends net.opro.product.odcaw.api.ParameterImpl

OXSParameter で使用するための、テンプレートに関するパラメータを定義します。
インスタンス化には、OXSParameter.addTemplate() を用いてください。

関連項目:
OXSParameter

メソッドの概要
 void add(String Parameter, Reader Value)
          テンプレートに依存するパラメータを追加します。
 void add(String Parameter, String Value)
          テンプレートに依存するパラメータを追加します。
 String getName()
          setName で指定したテンプレート名を返します。
 int indexOf(String Parameter)
          指定したパラメータのインデックスを返します。
 String parameterAt(int Index)
          指定したパラメータ名を返します。
 void remove(int Index)
          指定したパラメータを削除します。
 void remove(String Parameter)
          指定したパラメータを削除します。
 void setName(String Value)
          テンプレート名を指定します。
 int size()
          パラメータの数を返します。
 Object valueAt(int Index)
          指定したパラメータ値を返します。
 Object valueAt(String Parameter)
          指定したパラメータ値を返します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

setName

public void setName(String Value)
テンプレート名を指定します。

HTTP によるリクエストの、TPパラメータに相当します。

パラメータ:
Value - 指定するテンプレート名

getName

public String getName()
setName で指定したテンプレート名を返します。

HTTP によるリクエストの、TPパラメータに相当します。

戻り値:
setName で指定したテンプレート名

add

public void add(String Parameter,
                String Value)
テンプレートに依存するパラメータを追加します。
Dataset コンポーネントに対するものや、Data の Type が Request のコンポーネントに対するもの等です。
複数のテンプレートを指定する場合も、パラメータ名の先頭にテンプレート名をつける必要はありません。
既存のパラメータ名を指定した場合は、指定したパラメータ値で上書きされます。

パラメータ:
Parameter - 追加するパラメータ名
Value - 追加するパラメータ値
関連項目:
add(String, Reader)

add

public void add(String Parameter,
                Reader Value)
テンプレートに依存するパラメータを追加します。
Dataset コンポーネントに対するものや、Data の Type が Request のコンポーネントに対するもの等です。
複数のテンプレートを指定する場合も、パラメータ名の先頭にテンプレート名をつける必要はありません
既存のパラメータ名を指定した場合は、指定したパラメータ値で上書きされます。

引数 Value から読み出される値は、UTF-8である必要があります。
java.io.InputStreamReader 等で、正しくUTF-8に変換してください。

パラメータ:
Parameter - 追加するパラメータ名
Value - 追加するパラメータ値を読み込むための java.io.Reader
関連項目:
add(String, String)

size

public int size()
パラメータの数を返します。

戻り値:
パラメータの数

remove

public void remove(int Index)
指定したパラメータを削除します。

パラメータ:
Index - 削除するパラメータのインデックス
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の size よりも大きい場合

remove

public void remove(String Parameter)
指定したパラメータを削除します。
見つからない場合は、何もしません。

パラメータ:
Parameter - 削除するパラメータ名

indexOf

public int indexOf(String Parameter)
指定したパラメータのインデックスを返します。

パラメータ:
Parameter - 検索対象のパラメータ名
戻り値:
指定したパラメータのインデックス。見つからない場合は -1。

parameterAt

public String parameterAt(int Index)
指定したパラメータ名を返します。

パラメータ:
Index - 返されるパラメータのインデックス
戻り値:
指定したパラメータ名
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の size よりも大きい場合

valueAt

public Object valueAt(int Index)
指定したパラメータ値を返します。

パラメータ:
Index - 返されるパラメータのインデックス
戻り値:
指定したパラメータ値
例外:
ArrayIndexOutOfBoundsException - Index が負の場合、または現在の size よりも大きい場合

valueAt

public Object valueAt(String Parameter)
指定したパラメータ値を返します。

パラメータ:
Parameter - 検索対象のパラメータ名
戻り値:
指定したパラメータ値

OPRO Japan Co.,Ltd.