OPROARTS API

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

Object
  上位を拡張 OPROARTSParameter

public class OPROARTSParameter
extends Object

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

作成者:
OPRO Japan Co.,Ltd. R&D Center
関連項目:
OPROARTSHandler.saveDocument(OPROARTSParameter, String, String), OPROARTSHandler.saveDirectPrintDocument(OPROARTSParameter, String, String), OPROARTSHandler.sendMail(OPROARTSParameter)

コンストラクタの概要
OPROARTSParameter()
          フォーマットが OPROARTSHandler.FORMAT_PDFTemplateParameter 数がゼロ、AttachedParameter 数がゼロ、 MailParameter が未指定の、OPROARTSParameter を作成します。
OPROARTSParameter(String cid, String uid, String password)
          フォーマットが OPROARTSHandler.FORMAT_PDFTemplateParameter 数がゼロ、AttachedParameter 数がゼロ、 MailParameter が未指定の、OPROARTSParameter を作成します。
 
メソッドの概要
 StreamAttachedParameter addStreamAttached()
          入力ストリームを使用したドキュメントへの添付ファイルに関するパラメータを定義する StreamAttachedParameter を追加します。
 StreamAttachedParameter addStreamAttached(InputStream content, String name)
          入力ストリームを使用したドキュメントへの添付ファイルに関するパラメータを定義する StreamAttachedParameter を追加します。
 TemplateParameter addTemplate()
          テンプレートに関するパラメータを定義する TemplateParameter を追加します。
 TemplateParameter addTemplate(String value)
          テンプレートに関するパラメータを定義する TemplateParameter を追加し、指定されたテンプレート名称を設定します。
 TextAttachedParameter addTextAttached()
          テキストデータを使用したドキュメントへの添付ファイルに関するパラメータを定義する TextAttachedParameter を追加します。
 TextAttachedParameter addTextAttached(Reader content, String name, String charset)
          テキストデータを使用したドキュメントへの添付ファイルに関するパラメータを定義する TextAttachedParameter を追加します。
 TextAttachedParameter addTextAttached(String content, String name, String charset)
          テキストデータを使用したドキュメントへの添付ファイルに関するパラメータを定義する TextAttachedParameter を追加します。
 AttachedParameter attachedAt(int index)
          指定した AttachedParameter を返します。
 String getDocumentAuthor()
          setDocumentAuthor(String) で指定した、ドキュメントのプロパティ「作成者」の値を返します。
 String getDocumentKeyword()
          setDocumentKeyword(String) で指定した、ドキュメントのプロパティ「キーワード」の値を返します。
 String getDocumentSubtitle()
          setDocumentSubtitle(String) で指定した、ドキュメントのプロパティ「サブタイトル」の値を返します。
 String getDocumentTitle()
          setDocumentTitle(String) で指定した、ドキュメントのプロパティ「タイトル」の値を返します。
 boolean getFontEmbedding()
          setFontEmbedding で設定したフォントの埋め込みを可能にするかどうかを示す boolean を返します。
 int getFormat()
          setFormat(int) で設定したフォーマットを返します。
 MailParameter getMail()
          setMail(MailParameter) で設定した MailParameter を返します。
 boolean getPreview()
          setPreview(boolean)で設定した、プレビューとして出力するかどうかを示すbooleanを返します。
 OPROARTSResponseInfo lastResponseInfo()
          直前に行ったドキュメント生成指示等の結果、OPROARTSサーバーから返却された情報を返します。
 void removeAttached(int index)
          指定した AttachedParameter を削除します。
 void removeTemplate(int index)
          指定した TemplateParameter を削除します。
 void setAuthentication(String cid, String uid, String password)
          OPROARTS を利用するための認証情報を設定します。
 void setDocumentAuthor(String documentAuthor)
          ドキュメントのプロパティ「作成者」の値を設定します。
 void setDocumentKeyword(String documentKeyword)
          ドキュメントのプロパティ「キーワード」の値を設定します。
 void setDocumentSubtitle(String documentSubtitle)
          ドキュメントのプロパティ「サブタイトル」の値を設定します。
 void setDocumentTitle(String documentTitle)
          ドキュメントのプロパティ「タイトル」の値を設定します。
 void setFontEmbedding(boolean value)
          フォントの埋め込みを可能にするかどうかを設定します。
 void setFormat(int value)
          ドキュメントのフォーマットを設定します。
 void setMail(MailParameter mailParameter)
          メール送信に関するパラメータを定義するMailParameterを設定します。
 void setPreview(boolean value)
          プレビューとして出力するかどうかを設定します。
 int sizeAttached()
          AttachedParameter の数を返します。
 int sizeTemplate()
          TemplateParameter の数を返します。
 TemplateParameter templateAt(int index)
          指定した TemplateParameter を返します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

OPROARTSParameter

public OPROARTSParameter(String cid,
                         String uid,
                         String password)
フォーマットが OPROARTSHandler.FORMAT_PDFTemplateParameter 数がゼロ、AttachedParameter 数がゼロ、 MailParameter が未指定の、OPROARTSParameter を作成します。

引数の内容は、OPROARTSサーバー の認証、および、集計に用いられます。
OPROARTS の契約内容に合わせ正しい組み合わせで値をセットしてください。

パラメータ:
cid - OPROARTS を利用するための、CID
uid - OPROARTS を利用するための、UID
password - UID に対するパスワード

OPROARTSParameter

public OPROARTSParameter()
フォーマットが OPROARTSHandler.FORMAT_PDFTemplateParameter 数がゼロ、AttachedParameter 数がゼロ、 MailParameter が未指定の、OPROARTSParameter を作成します。

OPROARTSHandler でドキュメント生成指示等を行う前に、 setAuthentication で認証情報を設定する必要があります。

導入されたバージョン:
2009.07.08
関連項目:
setAuthentication(String, String, String)
メソッドの詳細

setAuthentication

public void setAuthentication(String cid,
                              String uid,
                              String password)
OPROARTS を利用するための認証情報を設定します。

認証情報は、OPROARTSサーバー の認証、および、集計に用いられます。
OPROARTS の契約内容に合わせ正しい組み合わせで値をセットしてください。

パラメータ:
cid - OPROARTS を利用するための、CID
uid - OPROARTS を利用するための、UID
password - UID に対するパスワード

setFormat

public void setFormat(int value)
ドキュメントのフォーマットを設定します。

下記のいずれかの値をセットしてください。

但し、OPROARTSHandler.saveDirectPrintDocument(OPROARTSParameter, String, String) メソッドの処理時には、このメソッドで指定されたフォーマットは無視されます。

パラメータ:
value - 設定するフォーマット

getFormat

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

戻り値:
setFormat(int) で設定したフォーマット

addTemplate

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

OPROARTSHandler の指示メソッド呼び出し前に、本メソッドを使用して OPROARTSParameter に1つ以上のテンプレートを追加してください。

戻り値:
追加された TemplateParameter

addTemplate

public TemplateParameter addTemplate(String value)
テンプレートに関するパラメータを定義する TemplateParameter を追加し、指定されたテンプレート名称を設定します。

パラメータ:
value - 追加された TemplateParameter に設定するテンプレート名称
戻り値:
追加された TemplateParameter
関連項目:
addTemplate(), TemplateParameter.setName(String)

sizeTemplate

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

戻り値:
TemplateParameter の数

templateAt

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

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

removeTemplate

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

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

setMail

public void setMail(MailParameter mailParameter)
メール送信に関するパラメータを定義するMailParameterを設定します。

OPROARTSHandler.sendMail(OPROARTSParameter)メソッドでメール送信の指示を行なう場合、本メソッドを使用してOPROARTSParameterに適切な値をセットしてください。

パラメータ:
mailParameter - 設定するMailParameter
関連項目:
MailParameter

getMail

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

戻り値:
setMail(MailParameter) で設定した MailParameter
関連項目:
MailParameter

addTextAttached

public TextAttachedParameter addTextAttached()
テキストデータを使用したドキュメントへの添付ファイルに関するパラメータを定義する TextAttachedParameter を追加します。

戻り値:
追加された TextAttachedParameter
導入されたバージョン:
2008.10.27
関連項目:
addTextAttached(String, String, String), addTextAttached(Reader, String, String)

addTextAttached

public TextAttachedParameter addTextAttached(String content,
                                             String name,
                                             String charset)
テキストデータを使用したドキュメントへの添付ファイルに関するパラメータを定義する TextAttachedParameter を追加します。

パラメータ:
content - 添付ファイルの内容
name - ドキュメントへの添付ファイルに使用するファイル名
charset - 添付ファイルに使用する文字エンコーディング
戻り値:
追加された TextAttachedParameter
導入されたバージョン:
2008.10.27
関連項目:
addTextAttached(Reader, String, String)

addTextAttached

public TextAttachedParameter addTextAttached(Reader content,
                                             String name,
                                             String charset)
テキストデータを使用したドキュメントへの添付ファイルに関するパラメータを定義する TextAttachedParameter を追加します。

パラメータ:
content - 添付ファイルの内容
name - ドキュメントへの添付ファイルに使用するファイル名
charset - 添付ファイルに使用する文字エンコーディング
戻り値:
追加された TextAttachedParameter
導入されたバージョン:
2008.10.27
関連項目:
addTextAttached(String, String, String)

addStreamAttached

public StreamAttachedParameter addStreamAttached()
入力ストリームを使用したドキュメントへの添付ファイルに関するパラメータを定義する StreamAttachedParameter を追加します。

戻り値:
追加された StreamAttachedParameter
導入されたバージョン:
2008.10.27
関連項目:
addStreamAttached(InputStream, String)

addStreamAttached

public StreamAttachedParameter addStreamAttached(InputStream content,
                                                 String name)
入力ストリームを使用したドキュメントへの添付ファイルに関するパラメータを定義する StreamAttachedParameter を追加します。

パラメータ:
content - 添付ファイルの内容
name - ドキュメントへの添付ファイルに使用するファイル名
戻り値:
追加された StreamAttachedParameter
導入されたバージョン:
2008.10.27

sizeAttached

public int sizeAttached()
AttachedParameter の数を返します。

戻り値:
AttachedParameter の数
導入されたバージョン:
2008.10.27

removeAttached

public void removeAttached(int index)
指定した AttachedParameter を削除します。

パラメータ:
index - 削除する AttachedParameter のインデックス
導入されたバージョン:
2008.10.27

attachedAt

public AttachedParameter attachedAt(int index)
指定した AttachedParameter を返します。

パラメータ:
index - 返される AttachedParameter のインデックス
戻り値:
指定した AttachedParameter
導入されたバージョン:
2008.10.27
関連項目:
addTextAttached(), addStreamAttached()

setFontEmbedding

public void setFontEmbedding(boolean value)
フォントの埋め込みを可能にするかどうかを設定します。
この設定は PDF形式でのみ有効です。

パラメータ:
value - フォントの埋め込みを可能にする場合は true、そうでない場合は false。既定値は false
導入されたバージョン:
2009.07.08

getFontEmbedding

public boolean getFontEmbedding()
setFontEmbedding で設定したフォントの埋め込みを可能にするかどうかを示す boolean を返します。

戻り値:
setFontEmbedding で設定したフォントの埋め込みを可能にするかどうかを示す boolean
導入されたバージョン:
2009.07.08

getDocumentTitle

public String getDocumentTitle()
setDocumentTitle(String) で指定した、ドキュメントのプロパティ「タイトル」の値を返します。

戻り値:
setDocumentTitle(String) で指定した、ドキュメントのプロパティ「タイトル」の値
導入されたバージョン:
2014.09.05

setDocumentTitle

public void setDocumentTitle(String documentTitle)
ドキュメントのプロパティ「タイトル」の値を設定します。
この設定は PDF形式でのみ有効です。

パラメータ:
documentTitle - ドキュメントのプロパティ「タイトル」の値
導入されたバージョン:
2014.09.05

getDocumentAuthor

public String getDocumentAuthor()
setDocumentAuthor(String) で指定した、ドキュメントのプロパティ「作成者」の値を返します。

戻り値:
setDocumentAuthor(String) で指定した、ドキュメントのプロパティ「作成者」の値
導入されたバージョン:
2014.09.05

setDocumentAuthor

public void setDocumentAuthor(String documentAuthor)
ドキュメントのプロパティ「作成者」の値を設定します。
この設定は PDF形式でのみ有効です。

パラメータ:
documentAuthor - ドキュメントのプロパティ「作成者」の値
導入されたバージョン:
2014.09.05

getDocumentSubtitle

public String getDocumentSubtitle()
setDocumentSubtitle(String) で指定した、ドキュメントのプロパティ「サブタイトル」の値を返します。

戻り値:
setDocumentSubtitle(String) で指定した、ドキュメントのプロパティ「サブタイトル」の値
導入されたバージョン:
2014.09.05

setDocumentSubtitle

public void setDocumentSubtitle(String documentSubtitle)
ドキュメントのプロパティ「サブタイトル」の値を設定します。
この設定は PDF形式でのみ有効です。

パラメータ:
documentSubtitle - ドキュメントのプロパティ「サブタイトル」の値
導入されたバージョン:
2014.09.05

getDocumentKeyword

public String getDocumentKeyword()
setDocumentKeyword(String) で指定した、ドキュメントのプロパティ「キーワード」の値を返します。

戻り値:
setDocumentKeyword(String) で指定した、ドキュメントのプロパティ「キーワード」の値
導入されたバージョン:
2014.09.05

setDocumentKeyword

public void setDocumentKeyword(String documentKeyword)
ドキュメントのプロパティ「キーワード」の値を設定します。
この設定は PDF形式でのみ有効です。

パラメータ:
documentKeyword - ドキュメントのプロパティ「キーワード」の値
導入されたバージョン:
2014.09.05

getPreview

public boolean getPreview()
setPreview(boolean)で設定した、プレビューとして出力するかどうかを示すbooleanを返します。

戻り値:
setPreview(boolean)で設定した、プレビューとして出力するかどうかを示すboolean
導入されたバージョン:
2015.11.30

setPreview

public void setPreview(boolean value)
プレビューとして出力するかどうかを設定します。
この設定は、PDF形式またはOPR形式を指定した ドキュメントの作成(OPROARTSHandler.saveDocument(OPROARTSParameter, String, String)OPROARTSHandler.saveDirectPrintDocument(OPROARTSParameter, String, String)) でのみ有効です。

パラメータ:
value - プレビューとして出力する場合はtrue
導入されたバージョン:
2015.11.30

lastResponseInfo

public OPROARTSResponseInfo lastResponseInfo()
直前に行ったドキュメント生成指示等の結果、OPROARTSサーバーから返却された情報を返します。

OPROARTSサーバーから返却された情報は、このクラスのインスタンスを引数としてOPROARTSHandlerの以下のメソッドを呼び出した際に設定されます。

戻り値:
直前に行ったドキュメント生成指示等の結果、OPROARTSサーバーから返却された情報
導入されたバージョン:
2012.10.25

OPRO Japan Co.,Ltd.