OPRO X Server API

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

Object
  拡張net.opro.product.odcaw.api.OXSParameter

public class OXSParameter
extends Object

OXSHandler を使用する際の各種パラメータを定義します。

関連項目:
OXSHandler.syncCreate, OXSHandler.asyncCreate, OXSHandler.asyncPrint, OXSHandler.asyncFax, OXSHandler.asyncMail

コンストラクタの概要
OXSParameter()
          フォーマットが OXSHandler.FORMAT_OPRTemplateParameter 数がゼロの OXSParameter を作成します。
 
メソッドの概要
 void addAttached(String Name)
          ドキュメントに添付するファイル名を追加します。
 void addAttached(String[] Names)
          ドキュメントに添付するファイル名を複数追加します。
 TemplateParameter addTemplate()
          テンプレートに関するパラメータを定義する TemplateParameter を追加します。
 TemplateParameter addTemplate(String Name)
          テンプレートに関するパラメータを定義する TemplateParameter を追加し、指定した名前を設定します。
 String attachedAt(int Index)
          指定した添付ファイル名を返します。
 int attachedIndexOf(String Name)
          指定した添付ファイル名の最初のインデックスを返します。
 void clearAttached()
          全ての添付ファイル名を削除します。
 void clearTemplate()
          全ての TemplateParameter を削除します。
 String getExtension()
          setExtension で設定した拡張子を返します。
 FaxParameter getFax()
          setFax で設定した FaxParameter を返します。
 int getFormat()
          setFormat で設定したフォーマットを返します。
 MailParameter getMail()
          setMail で設定した MailParameter を返します。
 PrintParameter getPrint()
          setPrint で設定した PrintParameter を返します。
 String getXsl()
          setXsl で設定した XSLファイル名を返します。
 void removeAttached(int Index)
          指定した添付ファイル名を削除します。
 void removeAttached(String Name)
          指定した添付ファイル名を削除します。
 void removeTemplate(int Index)
          指定した TemplateParameter を削除します。
 void removeTemplate(String Name)
          指定した名前の TemplateParameter を削除します。
 void removeTemplate(TemplateParameter tp)
          指定した TemplateParameter を削除します。
 void setExtension(String Value)
          OXR形式のドキュメントを、XSL を用いて変換する場合、変換後の拡張子を設定します。
 void setFax(FaxParameter p)
          FAX送信に関するパラメータを定義する FaxParameter を設定します。
 void setFormat(int Value)
          フォーマットを設定します。
 void setMail(MailParameter p)
          メール送信に関するパラメータを定義する MailParameter を設定します。
 void setPrint(PrintParameter p)
          サーバサイド印刷に関するパラメータを定義する PrintParameter を設定します。
 void setXsl(String Value)
          OXR形式のドキュメントを変換するための XSLファイル名を設定します。
 int sizeAttached()
          添付ファイル名の数を返します。
 int sizeTemplate()
          TemplateParameter の数を返します。
 TemplateParameter templateAt(int Index)
          指定した TemplateParameter を返します。
 TemplateParameter templateAt(String Name)
          指定した名前の TemplateParameter を返します。
 int templateIndexOf(TemplateParameter tp)
          指定した TemplateParameter のインデックスを返します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

OXSParameter

public OXSParameter()
フォーマットが OXSHandler.FORMAT_OPRTemplateParameter 数がゼロの OXSParameter を作成します。

メソッドの詳細

setFormat

public void setFormat(int Value)
フォーマットを設定します。

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

パラメータ:
Value - 設定するフォーマット OXSHandler.FORMAT_OPROXSHandler.FORMAT_OXROXSHandler.FORMAT_PDFOXSHandler.FORMAT_HTML のいずれか。
関連項目:
OXSHandler.FORMAT_OPR, OXSHandler.FORMAT_OXR, OXSHandler.FORMAT_PDF, OXSHandler.FORMAT_HTML

getFormat

public int getFormat()
setFormat で設定したフォーマットを返します。

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

戻り値:
setFormat で設定したフォーマット
関連項目:
OXSHandler.FORMAT_OPR, OXSHandler.FORMAT_OXR, OXSHandler.FORMAT_PDF, OXSHandler.FORMAT_HTML

setXsl

public void setXsl(String Value)
OXR形式のドキュメントを変換するための XSLファイル名を設定します。
フォーマットがOXR形式の場合のみ有効です。
また、XSLファイルは、OXS の設定ファイルの <ODDS>/<OPMS>/<XSLT_IN_FILE> で指定した場所に配置する必要があります。

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

パラメータ:
Value - 設定するXSLファイル名
導入されたバージョン:
2.2.1.0
関連項目:
setFormat, OXSHandler.FORMAT_OXR, setExtension

getXsl

public String getXsl()
setXsl で設定した XSLファイル名を返します。

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

戻り値:
setXsl で設定した XSLファイル名
導入されたバージョン:
2.2.1.0

setExtension

public void setExtension(String Value)
OXR形式のドキュメントを、XSL を用いて変換する場合、変換後の拡張子を設定します。
フォーマットがOXR形式の場合で、setXsl で XSLファイル名を指定した場合のみ有効です。

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

パラメータ:
Value - 設定する拡張子
導入されたバージョン:
2.2.1.0
関連項目:
setXsl

getExtension

public String getExtension()
setExtension で設定した拡張子を返します。

戻り値:
setExtension で設定した拡張子
導入されたバージョン:
2.2.1.0

addTemplate

public TemplateParameter addTemplate()
テンプレートに関するパラメータを定義する TemplateParameter を追加します。
複数の TemplateParameter を使用した場合、各 TemplateParameter が定義するパラメータに従ったドキュメントが、順番通りに結合された、単一のドキュメントが生成されます。

戻り値:
追加された TemplateParameter
関連項目:
TemplateParameter

addTemplate

public TemplateParameter addTemplate(String Name)
テンプレートに関するパラメータを定義する TemplateParameter を追加し、指定した名前を設定します。
複数の TemplateParameter を使用した場合、各 TemplateParameter が定義するパラメータに従ったドキュメントが、順番通りに結合された、単一のドキュメントが生成されます。

パラメータ:
Name - 追加された TemplateParameter に設定するテンプレート名
戻り値:
追加された TemplateParameter
導入されたバージョン:
2.2.1.0
関連項目:
TemplateParameter

sizeTemplate

public int sizeTemplate()
TemplateParameter の数を返します。

戻り値:
TemplateParameter の数

removeTemplate

public void removeTemplate(int Index)
指定した TemplateParameter を削除します。

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

removeTemplate

public void removeTemplate(String Name)
指定した名前の TemplateParameter を削除します。
TemplateParameter が見つからない場合は、何もしません。

パラメータ:
Name - 削除する TemplateParameter の名前

removeTemplate

public void removeTemplate(TemplateParameter tp)
指定した TemplateParameter を削除します。

パラメータ:
tp - 削除する TemplateParameter

clearTemplate

public void clearTemplate()
全ての TemplateParameter を削除します。


templateAt

public TemplateParameter templateAt(int Index)
指定した TemplateParameter を返します。

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

templateAt

public TemplateParameter templateAt(String Name)
指定した名前の TemplateParameter を返します。

パラメータ:
Name - 検索する TemplateParameter の名前
戻り値:
指定した名前の TemplateParameter。見つからない場合は null。

templateIndexOf

public int templateIndexOf(TemplateParameter tp)
指定した TemplateParameter のインデックスを返します。

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

setPrint

public void setPrint(PrintParameter p)
サーバサイド印刷に関するパラメータを定義する PrintParameter を設定します。
使用する OXSHandler が参照する OXS が生成するドキュメントを、 設定した PrintParameter が指す OXS Print Edition 又は OXS Print Service を使用して、印刷します。

パラメータ:
p - 設定する PrintParameter
導入されたバージョン:
2.2.1.0
関連項目:
PrintParameter

getPrint

public PrintParameter getPrint()
setPrint で設定した PrintParameter を返します。

戻り値:
setPrint で設定した PrintParameter
導入されたバージョン:
2.2.1.0
関連項目:
PrintParameter

setFax

public void setFax(FaxParameter p)
FAX送信に関するパラメータを定義する FaxParameter を設定します。
使用する OXSHandler が参照する OXS が生成するドキュメントを、 設定した FaxParameter が指す OXS Fax Edition 又は OXS Fax Service を使用して、送信します。

パラメータ:
p - 設定する FaxParameter
導入されたバージョン:
2.2.1.0
関連項目:
FaxParameter

getFax

public FaxParameter getFax()
setFax で設定した FaxParameter を返します。

戻り値:
setFax で設定した FaxParameter
導入されたバージョン:
2.2.1.0
関連項目:
FaxParameter

setMail

public void setMail(MailParameter p)
メール送信に関するパラメータを定義する MailParameter を設定します。
使用する OXSHandler が参照する OXS が生成するドキュメントを、 設定した MailParameter が指す OXS Mail Service を使用して、送信します。

パラメータ:
p - 設定する MailParameter
導入されたバージョン:
2.2.1.0
関連項目:
MailParameter

getMail

public MailParameter getMail()
setMail で設定した MailParameter を返します。

戻り値:
setMail で設定した MailParameter
導入されたバージョン:
2.2.1.0
関連項目:
MailParameter

addAttached

public void addAttached(String Name)
ドキュメントに添付するファイル名を追加します。
ドキュメントにファイルを添付できるのは、フォーマットがOPR形式又はOXR形式の場合のみです。
また、OXS の設定ファイルの <ODDS>/<PATH>/<ATTACHMENT>/<LOCAL> で指定した場所に存在しないファイルは添付されません。

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

パラメータ:
Name - ドキュメントに添付するファイル名
関連項目:
setFormat

addAttached

public void addAttached(String[] Names)
ドキュメントに添付するファイル名を複数追加します。
ドキュメントにファイルを添付できるのは、フォーマットがOPR形式又はOXR形式の場合のみです。
また、OXS の設定ファイルの <ODDS>/<PATH>/<ATTACHMENT>/<LOCAL> で指定した場所に存在しないファイルは添付されません。

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

パラメータ:
Names - ドキュメントに添付するファイル名
関連項目:
setFormat

sizeAttached

public int sizeAttached()
添付ファイル名の数を返します。

戻り値:
添付ファイル名の数

clearAttached

public void clearAttached()
全ての添付ファイル名を削除します。


removeAttached

public void removeAttached(String Name)
指定した添付ファイル名を削除します。

パラメータ:
Name - 削除する添付ファイル名

removeAttached

public void removeAttached(int Index)
指定した添付ファイル名を削除します。

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

attachedAt

public String attachedAt(int Index)
指定した添付ファイル名を返します。

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

attachedIndexOf

public int attachedIndexOf(String Name)
指定した添付ファイル名の最初のインデックスを返します。

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

OPRO Japan Co.,Ltd.