複数のIOD中間ファイルを結合し、PDFファイルを生成するAPI。
各IOD中間ファイルは Storage-Serviceの管理するディレクトリ(標準では storage/)内に保存しておく必要があります。
また、PDFファイルおよびログファイルは Storage-Serviceの管理するディレクトリ(標準では storage/)内に生成されます。
メソッド
旧バージョン
からの継続
IOIntegration() コンストラクタ add() IODレイアウトファイルパスの追加 getMessage() 実行結果メッセージの取得 setLog() ログファイルパスの設定(※新バージョンでは使用できません) toPDF() PDFファイルの生成 新バージョン
追加
文書情報defineTitle() タイトルの設定 defineSubTitle() サブタイトルの設定 defineAuthor() 作成者の設定 defineApplication() 作成アプリケーション名の設定
セキュリティsetOpenPassword() オープンパスワードの設定 setSecurityPassword() セキュリティパスワードの設定 printSecurity() 印刷許可フラグの設定 modifySecurity() 編集許可フラグの設定 copySecurity() テキスト抽出コピー許可フラグの設定 IOD
中間ファイルsetDelete() IOD中間ファイルの削除フラグを設定
(Object) IOIntegration()
なし
あらかじめ作成しておいたIOD中間ファイルを結合して、PDFファイルを生成するオブジェクト構築します。
void 型インスタンスメソッド
(void) add(String path)
IOD中間ファイルパスの追加
path: IOD中間ファイルパス(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
なし
IOD中間ファイルパスを追加します。
連続して呼び出すことにより、複数IOD中間ファイルパスを結合してのPDFファイル生成が可能です。
(IOD中間ファイルパスは、当メソッドの追加順に結合されます)
文字列型インスタンスメソッド
(String) getMessage()
エラーメッセージを取得
なし
エラーメッセージ文字列
PDFファイル作成時にエラーが発生した場合、エラーコードに対応するメッセージを返却します。
このメソッドは、toPDF メソッド実行後に呼び出して下さい。
void 型インスタンスメソッド
(void) setLog(String path)
ログファイルパスの設定
path: ログファイルのパス(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
なし
ログファイルのパスを設定します。
ログファイルは、PDFファイル作成時に同時に出力されます。
なお、既存の同名ファイルが存在する場合は内容が上書きされます(ログデータの追記はできません)。
※当メソッドは旧バージョン互換用に残されています。新バージョン機能を用いる場合には使用できません。
数値型インスタンスメソッド
(number) toPDF(String path)
PDFファイル(PDF)の作成
path: 出力PDFファイル(Storage-Serviceの管理するディレクトリ(標準は storage/)からの相対形式で表されるパス名[英数字])
ステータスコード
動作が正常に終了した場合 0 が返されます。
PDFファイルの生成処理を実行します。
処理内部で発生したエラーについてはステータスコードは戻り値、メッセージについてはgetMessageメソッドにより確認します。
void 型インスタンスメソッド
(void) defineTitle(String title)
PDF文書情報のタイトルの設定
title: 文書情報のタイトル
なし
PDFの文書情報のタイトルを設定します。
void 型インスタンスメソッド
(void) defineSubTitle(String subtitle)
PDF文書情報のサブタイトルの設定
subtitle: 文書情報のサブタイトル
なし
PDFの文書情報のサブタイトルを設定します。
void 型インスタンスメソッド
(void) defineAuthor(String author)
PDF文書情報の作成者の設定
author: 文書情報の作成者
なし
PDFの文書情報の作成者を設定します。
void 型インスタンスメソッド
(void) defineApplication(String appliname)
PDF文書情報の作成アプリケーション名の設定
appliname: 文書情報の作成アプリケーション名
なし
PDFの文書情報の作成アプリケーション名を設定します。
void 型インスタンスメソッド
(void) setOpenPassword(String openpass)
PDFファイルのオープンパスワードの設定
openpass: オープンパスワード
なし
PDFファイルのオープンパスワードを設定します。
オープンパスワードとセキュリティパスワードが同一値の場合はエラーとなります。
void 型インスタンスメソッド
(void) setSecurityPassword(String secpass)
PDFファイルのセキュリティパスワードの設定
secpass: セキュリティパスワード
なし
PDFのセキュリティパスワードを設定します。
オープンパスワードとセキュリティパスワードが同一値の場合はエラーとなります。
セキュリティを設定せずにセキュリティパスワードを設定した場合はエラーとなります。
void 型インスタンスメソッド
(void) printSecurity(String flgname)
PDFセキュリティの印刷許可フラグの設定
flgname: 印刷許可フラグ文字列
なし
PDFセキュリティの印刷許可フラグを設定します。
印刷許可フラグ文字列は、以下のいずれかを設定します。
・PRINT_ENABLE(印刷可)
・PRINT_DISABLE(印刷不可)
void 型インスタンスメソッド
(void) modifySecurity(String flgname)
PDFセキュリティの変更許可フラグの設定
flgname: 変更許可フラグ文字列
なし
PDFセキュリティの変更許可フラグを設定します。
変更許可フラグ文字列は、以下のいずれかを設定します。
・MODIFY_FORM_AND_ANNOTATION(注釈の作成、フォームフィールドの入力、および既存の署名フィールドに署名)
・MODIFY_FORM_AND_ASSEMBLY(ページレイアウト、フォームフィールドの入力、および既存の署名フィールドに署名)
・MODIFY_ALL(ページの抽出を除くすべての操作)
・MODIFY_DISABLE(変更不可)
void 型インスタンスメソッド
(void) copySecurity(String flgname)
PDFセキュリティのテキスト抽出コピー許可フラグの設定
flgname: テキスト抽出コピー許可フラグ文字列
なし
PDFセキュリティのテキスト抽出コピー許可フラグを設定します。
テキスト抽出コピー許可フラグ文字列は、以下のいずれかを設定します。
・COPY_AND_ACCESSBILITY_ENABLE(テキスト抽出コピー可)
・COPY_AND_ACCESSBILITY_DISABLE(テキスト抽出コピー不可)
void 型インスタンスメソッド
(void) setDelete(boolean delete)
IOD中間ファイルの削除フラグを設定
delete: true : 削除する false : 削除しない
なし
PDFファイル作成時に、IOD中間ファイルを削除するか設定します。