8-3-4　使用する関数（Java版）

設定した動作設定に従って処理します。

void doTransaction()

なし

なし

SVF製品により生成された出力ファイルのファイル名リストを取得します。

この関数は、doTransaction実行後に使用します。

Vector<String> getCreatedFileNameList()

なし

SVF製品により生成された出力ファイル名を要素としたリスト

1ジョブ間での合計ページ数を取得します。

使用する場合は、doTransactionの前にsetPrintTotalPageCountMode(boolean)を使用してください。

この関数は、doTransaction実行後に使用します。

int getPrintTotalPageCount()

なし

印刷ページ数

setUndeleteSourceFile関数で削除設定をしている場合に、データファイルが削除されたかどうかを確認し、その結果を返します。

この関数は、次のいずれかの条件で削除されたかどうかを確認します

この関数は、doTransaction実行後に使用します。

boolean getSourceFileDeleteResult()

なし

Universal Connect/Xサーバー側のUCXSingle処理スレッドの実行結果を取得します。

この関数は、doTransaction実行後に使用します。

int getUCXSingleResult()

なし

Universal Connect/Xサーバー側の印刷処理スレッドの実行結果を取得します。

この関数は、doTransaction実行後に使用します。

int getUniConXResult()

なし

RDEにスプールした時に割り当てられた文書管理番号を取得します。

この関数はRDEがセットアップされている状態で、ジョブの出力先がRDEの場合のみ有効です。

この関数は、doTransaction実行後に使用します。

int getVrGetManageNum()

なし

returnResultTransferDataFileが設定されたかどうかを確認します。

boolean isReturnResultTransferDataFile()

なし

returnResultTransferDataFileが設定されている場合に、Universal Connect/Xサーバーへのファイル転送が正常終了したかどうかを確認します。

この関数は、doTransaction実行後に使用します。

boolean isSuccessReturnResultTransferDataFile()

なし

UCXSingleからUniversal Connect/Xサーバーへデータファイルを転送する場合、Universal Connect/Xサーバーの処理終了を待たずにファイル転送終了通知をUCXSingle側で受け取ります。

この関数は次の条件をすべて満たす場合に有効です。

Universal Connect/Xサーバーは、データファイルの受信を完了するとUCXSingleに応答を返却し通信を切断します。その後、サーバーでは要求された印刷を処理します。

この関数は、doTransaction実行前に使用します。

void returnResultTransferDataFile()

なし

なし

1/400ドット単位で印字位置を調節します。

様式ファイル、SVF環境設定、setAdjustmと併用した場合、データファイルの<start><end>タグ内で印字位置の設定があった場合には合計値が設定されます。

この関数は、doTransaction実行前に使用します。

void setAdjustd(int x, int y)

なし

1/10ミリ単位で印字位置を調節します。

様式ファイル、SVF環境設定、setAdjustdと併用した場合、データファイルの<start><end>タグ内で印字位置の設定があった場合には合計値が設定されます。

この関数は、doTransaction実行前に使用します。

void setAdjustm(int x, int y)

なし

BASIC認証、DIGEST認証をするための認証情報を設定します。

ユーザー名とパスワードの両方に長さ1以上の文字列を指定した場合に、doTransactionにおいて、BASIC認証またはDIGEST認証に対応した通信が行われます。

HTTP、またはHTTPSプロトコルを指定し、Universal Connect/X中継サーバーを経由する場合のみ利用できます。そのため、この関数で認証情報を設定し、Universal Connect/Xサーバーと直接通信をした場合は、doTransaction動作時に例外が発生します。

この関数は、doTransaction実行前に使用します。

void setAuthorization(String username, String password)

なし

ログを標準出力へ出力するかどうかを指定します。

この関数を使用しない場合は、標準出力へログを出力しません。

この関数は doTransaction実行前に使用します。

void setConsoleLogEnable(boolean enable)

なし

データファイルのフォーマット形式としてUTF-8、またはそのほかのフォーマットを使用するかどうかを指定します。

データファイル形式で「UTF-8」を使用する場合は、通常setDataFileEncodingName("UTF-8")を使用します。

この関数は、動作設定の［ジョブ］でCSVデータフォーマットが「UTF-8」に指定されたジョブに対して、設定を解除する目的で使用してください。そのため通常はsetCsvDataFormatUTF8(0)とした上でsetDataFileEncodingName(String)を併用し、目的のファイルエンコーディングを指定してください。

この関数は、doTransaction実行前に使用します。

void setCsvDataFormatUTF8(int i)

なし

データファイルのエンコーディングを指定します。

使用しない場合は、動作設定に従います。

この関数は、doTransaction実行前に使用します。

void setDataFileEncodingName(String encName)

なし

Universal Connect/Xサーバーと通信する際に、HTTPヘッダーの値をBASE64エンコードするかどうかを指定します。

「true」を指定すると、HTTPヘッダーのエンコードが有効になります。これにより、データファイル名にASCII以外の文字コードを利用できます。HTTP/HTTPSを使用せず、直接Universal Connect/Xサーバーに接続する場合も同様です。

「false」に指定した場合は、HTTPヘッダーの値はJVMのデフォルトエンコーディングでバイト配列に変換したものをそのままUniversal Connect/Xサーバーに転送します。

この関数を使用しない場合の規定値は「false」ですが、次のコンストラクター、関数を使用した場合は「true」となります。

この関数は、doTransaction実行前に使用します。

void setHeaderTransferEncodeSupported(boolean enable)

なし

Universal Connect/Xサーバーに転送するイメージファイル名を指定します。

イメージファイルはUniversal Connect/Xサーバーで指定されたディレクトリに保存され、処理終了後、削除されます。

保存したファイルをSVF実行部に認識させるには、実行様式ファイル検索パスを保存ディレクトリに追加する必要があります。

この関数は、doTransaction実行前に使用します。

void setImageName(String imageName)

なし

秒単位でキープアライブ時間を指定します。

キープアライブ時間に「0」を指定した場合は、キープアライブは無効です。

キープアライブ時間の規定値は「0」（無効）ですが、この関数を使用しない場合でも、setTimeoutValue関数で1以上の値でタイムアウト時間を指定した場合は、setTimeoutValue設定値の半分の時間がキープアライブに設定されます。

この関数は、doTransaction実行前に使用します。

void setKeepAliveValue(int value)

なし

ログファイルエンコーディングを設定します。

ログファイルエンコーディングにnullを指定した場合は、デフォルトエンコーディングを採用します。

この関数を使用しない場合はUTF-8で出力します。

この関数は、doTransaction実行前に使用します。

void setLogFileEncoding(String encoding)

なし

処理実行結果ログファイル名を指定します。

ログファイル名を指定していない場合、または空文字を指定した場合、ログは出力されません。

指定したファイルが存在する場合は上書きされます。

この関数は、doTransaction実行前に使用します。

void setLogFileName(String fileName)

なし

ログファイルの日時書式を設定します。

日時書式を指定しない場合はデフォルトの書式が適用されます。

この関数は、doTransaction実行前に使用します。

void setLogTimestampPattern(String pattern)

なし

1ジョブ間で合計ページ数を取得できるようにし、生成ファイルを削除するかどうかを設定します。

引数には生成したファイルを生成直後に削除するかどうかを指定します。ファイル出力しないSVFプリンター機種を指定した場合は、引数に意味を持ちません。そのため、通常falseを指定します。ファイル生成が不要で、ページ数のみ取得したいケースではtrueを指定します。

生成ファイルを削除する指定をした場合は、次の制限があります。

ページ数を取得する場合は、getPrintTotalPageCountを使用してください。

この関数は、doTransaction実行前に使用します。

void setPrintTotalPageCountMode(boolean flag)

なし

1ジョブ間での合計ページ数を取得するかどうか、生成ファイルを削除するかどうかを設定します。

この関数は互換性維持のために存在します。setPrintTotalPageCountMode(boolean)を使用してください。

modeは合計ページ数を取得するかどうかを指定します。

「合計ページ数を取得しない」を指定した場合は、この関数を指定しないのと同意です。

「合計ページ数を取得する」を指定した場合に限り引数flagが有効となります。

flagは生成したファイルを生成直後に削除するかどうかを指定します。ファイル出力しないSVFプリンター機種を指定した場合は、引数に意味を持ちません。そのため通常falseを指定します。ファイル生成が不要で、ページ数のみ取得したいケースではtrueを指定します。

生成ファイルを削除する指定をした場合は、次の制限があります。

ページ数を取得する場合は、getPrintTotalPageCountを使用してください。

この関数は、doTransaction実行前に使用します。

void setPrintTotalPageCountMode(int mode , boolean flag)

なし

SVF製品により生成される出力ファイルを、UCXSingleで指定したファイル名で受け取るように設定します。

この関数を使用すると、ジョブの文書分割とメール送信はできなくなります。

この関数を使用しない場合、または空文字列を指定した場合にSVFファイル機種に出力するとUniversal Connect/Xサーバー側に出力ファイルが生成されます。

指定したファイルが存在する場合は上書きされます。

この関数は、doTransaction実行前に使用します。

void setResultFileName(String fileName)

なし

動作設定のJob IDを指定します。

この関数は、doTransaction実行前に使用します。

void setSettingName(String settingName)

なし

データファイル名、またはデータファイル名を表すURLを指定します。

指定しない場合、動作設定で指定したデータファイルが適用されます。

この関数は、doTransaction実行前に使用します。

void setSourceName(String sourceName)

なし

秒単位でタイムアウト時間を設定します。

タイムアウト時間は、Socketでの通信の場合には接続完了後、処理開始から処理完了の状態になるまでのタイムアウト時間となります。

HTTP/HTTPS通信の場合には接続タイムアウト時間および、接続完了後、処理開始から処理完了の状態になるまでのタイムアウト時間となります。

タイムアウト時間に「0」を指定した場合は、タイムアウトが発生しません。タイムアウト時間の規定値は「0」です。明示的にタイムアウト秒数を指定しない限り、タイムアウトにはなりません。

setKeepAliveValue関数でキープアライブ時間を指定しない状況で、setTimeoutValue関数により正数のタイムアウト秒数を指定した場合は、キープアライブ時間にsetTimeoutValue関数で指定したタイムアウト秒数の1/2が設定されます。

この関数は、doTransaction実行前に使用します。

void setTimeoutValue(int value)

なし

処理が正常終了した場合に、データファイルを削除せずに残すかどうかを指定します。

setSourceNameでデータファイル名を指定した場合のみ有効です。

規定値は「false」です。指定しない場合は、データファイルを削除します。

この関数は、doTransaction実行前に使用します。

void setUndeleteSourceFile(boolean flag)

なし

処理が異常終了した場合に、データファイルを削除せずに残すかどうかを指定します。

setSourceName関数でデータファイル名を指定した場合のみ有効です。

規定値は「false」です。指定しない状態で処理が異常終了した場合は、データファイルを削除します。

この関数は、doTransaction実行前に使用します。

void setUndeleteSourceFileIfError(boolean flag)

なし

接続するUniversal Connect/Xサーバーを指定します。

この関数は、doTransaction実行前に使用します。

void setUniConXServer(String host, int port)

なし

接続するUniversal Connect/X中継サーバーを指定します。

ポート番号にUniversal Connect/Xサーバーのポート番号を指定した場合は、doTransactionにおいてプロトコルの例外が発生する場合があります。使用する場合は中継サーバーのポート番号を指定してください。

この関数は、doTransaction実行前に使用します。

void setUniConXServer(String protocol, String host, int port)

なし

接続するUniversal Connect/X中継サーバーを指定します。

この関数は、信頼されない証明書を利用しHTTPS接続のテストをするために使用します。環境情報プロパティには次の設定値を指定することが可能です。

ポート番号にUniversal Connect/Xサーバーのポート番号を指定した場合は、doTransactionにおいてプロトコルの例外が発生する場合があります。使用する場合は、中継サーバーのポート番号を指定してください。

この関数は、doTransaction実行前に使用します。

void setUniConXServer(String protocol, String host, int port, Properties env)

なし

Universal Connect/Xサーバーとファイルを送受信する際に、ファイルを圧縮するかどうかを指定します。

この関数はuseGZIPCompressionと等価です。

この関数は、doTransaction実行前に使用します。

void useCompression(boolean comp)

なし

Universal Connect/Xサーバーとファイルを送受信する際に、gzipでファイルを圧縮するかどうかを指定します。

この関数は、doTransaction実行前に使用します。

void useGZIPCompression(boolean comp)

なし

Universal Connect/Xサーバーとファイルを送受信する際に、zlibでファイルを圧縮するかどうかを指定します。

この関数は、doTransaction実行前に使用します。

void useZLIBCompression(boolean comp)

なし