OPRO X Server API

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

Object
  拡張net.opro.product.odcaw.api.SyncResponse
すべての実装インタフェース:
Response

public abstract class SyncResponse
extends Object
implements Response

OXSHandler の同期処理の戻り値であり、その結果を提供します。
処理結果の取得、生成されたドキュメントの取得等が可能です。

導入されたバージョン:
2.2.1.0
関連項目:
OXSHandler.syncCreate, OXSHandler.syncPrint, OXSHandler.syncFax, OXSHandler.syncMail

メソッドの概要
 String getAddress()
          この Response が参照する OXS のアドレスを返します。
 InputStream getDocument()
          生成されたドキュメントを受け取る入力ストリームを返します。
 String getDocumentUrl()
          生成される(生成された)ドキュメントのURLを返します。
 int getPort()
          この Response が参照する OXS のポート番号を返します。
abstract  int getResult()
          OXS の処理が完了した際の処理結果を返します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getAddress

public String getAddress()
インタフェース Response の記述:
この Response が参照する OXS のアドレスを返します。
OXS のアドレスは OXSHandler のコンストラクタに渡されたものです。

定義:
インタフェース Response 内の getAddress
戻り値:
この Response が参照する OXS のアドレス
関連項目:
OXSHandler

getPort

public int getPort()
インタフェース Response の記述:
この Response が参照する OXS のポート番号を返します。
OXS のポート番号は OXSHandler のコンストラクタに渡されたものです。

定義:
インタフェース Response 内の getPort
戻り値:
この Response が参照する OXS のポート番号
関連項目:
OXSHandler

getDocumentUrl

public String getDocumentUrl()
インタフェース Response の記述:
生成される(生成された)ドキュメントのURLを返します。

OXS の設定ファイルで出力ファイルを削除するように定義されている場合、生成完了後に定義された時間以上経過したドキュメントは削除されます。
このメソッドは、既に削除されている場合も、削除前のドキュメントのURLを返します。

定義:
インタフェース Response 内の getDocumentUrl
戻り値:
生成される(生成された)ドキュメントのURL
関連項目:
getDocument

getDocument

public InputStream getDocument()
                                throws IOException
インタフェース Response の記述:
生成されたドキュメントを受け取る入力ストリームを返します。
ドキュメントは getDocumentUrl に存在し、このメソッドは getDocumentUrl からドキュメントを受け取るための入力ストリームを返します。

OXS の設定ファイルで出力ファイルを削除するように定義されている場合、生成完了後に定義された時間以上経過したドキュメントは削除されます。
getDocumentUrl は、既に削除されている場合も、削除前のドキュメントのURLを返します。
既に削除されている場合、IOException がスローされます。
このメソッドを正しく使用するためには、出力ファイルの削除時間を充分な長さに設定しておく必要があります。

定義:
インタフェース Response 内の getDocument
戻り値:
生成されたドキュメントを受け取る入力ストリーム
例外:
IOException - 生成されたドキュメントの取得中に入出力エラーが発生した場合
関連項目:
getDocumentUrl

getResult

public abstract int getResult()
インタフェース Response の記述:
OXS の処理が完了した際の処理結果を返します。
処理が終了していない場合は、OXSHandler.STATUS_GENERATING を返します。

定義:
インタフェース Response 内の getResult
戻り値:
処理結果。 OXSHandler.STATUS_GENERATINGOXSHandler.STATUS_COMPLETEOXSHandler.STATUS_ERROROXSHandler.STATUS_CANCEL のいずれか。
関連項目:
OXSHandler.STATUS_COMPLETE, OXSHandler.STATUS_ERROR, OXSHandler.STATUS_CANCEL

OPRO Japan Co.,Ltd.