OPROARTS API

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

Object
  上位を拡張 TemplateParameter

public class TemplateParameter
extends Object

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

作成者:
OPRO Japan Co.,Ltd. R&D Center

メソッドの概要
 void addData(Reader value)
          ドキュメント生成に使用するテキストデータを追加します。
 void addData(String value)
          ドキュメント生成に使用するテキストデータを追加します。
 Object dataAt(int index)
          指定したテキストデータの値を返します。
 String getName()
          setName(String) で指定したテンプレート名を返します。
 void removeData(int index)
          指定したテキストデータを削除します。
 void setName(String value)
          テンプレート名を指定します。
 int sizeData()
          テキストデータの数を返します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

setName

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

OPROARTS の契約内容に合わせ、正しいテンプレート名を指定してください。
誤ったテンプレート名を指定された場合、OPROARTSHandler を用いたOPROARTSサーバーへの指示時に、 OPROARTSIllegalRequestException 例外が発生します。

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

getName

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

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

addData

public void addData(String value)
ドキュメント生成に使用するテキストデータを追加します。
複数のテキストデータを使用する場合、このメソッドが呼ばれた順にテンプレートにデータが適用されます。

このTemplateParameterが表すテンプレートが要求するテキストデータの数と、sizeData() が示すテキストデータの数が異なる場合、 予期しないドキュメントが作成される場合があります。
テキストデータの値が必要ない場合にも、長さゼロの文字列またはnullを指定して、このメソッドを呼び出してください。

パラメータ:
value - 追加するテキストデータ
関連項目:
addData(Reader)

addData

public void addData(Reader value)
ドキュメント生成に使用するテキストデータを追加します。

パラメータ:
value - 追加するテキストデータ
関連項目:
addData(String)

sizeData

public int sizeData()
テキストデータの数を返します。

戻り値:
テキストデータの数

dataAt

public Object dataAt(int index)
指定したテキストデータの値を返します。

パラメータ:
index - 返されるテキストデータのインデックス
戻り値:
指定したテキストデータの値

removeData

public void removeData(int index)
指定したテキストデータを削除します。

パラメータ:
index - 削除するテキストデータのインデックス

OPRO Japan Co.,Ltd.