com.JRcServer
インタフェース JRcResponse

public interface JRcResponse

JRcServerレスポンスインターフェイス.

導入されたバージョン:

JRcServerAPI 1.00

バージョン:

2006/09/06

作成者:

masahito suzuki

メソッドの概要

java.lang.String	getCharset() キャラクタセットを取得.
java.lang.String	getMimeType() Mimeタイプを取得.
java.io.OutputStream	getOutputStream() レスポンスにバイナリデータを出力する際に 使用するOutputStreamを取得.
int	getResult() 設定されている戻り値を取得.
java.lang.String	getResultMessage() 設定されている戻りメッセージを取得.
long	getSessionID() セッションIDを取得.
java.io.PrintWriter	getWriter() 文字データをクライアントに送り返すのに 使用するPrintWriterオブジェクトを取得.
boolean	isMode() データモードを取得.
void	setCharset(java.lang.String charset) キャラクタセットを設定.
void	setError(int result) 異常戻り値を設定.
void	setError(int result, java.lang.String message) 異常戻り値を設定.
void	setFatalError(int result) 復旧不能異常戻り値を設定.
void	setFatalError(int result, java.lang.String message) 復旧不能異常戻り値を設定.
void	setMimeType(java.lang.String mimeType) Mimeタイプを設定.
void	setSuccess(int result) 正常戻り値を設定.
void	setWarning(int result) 警告戻り値を設定.

メソッドの詳細

getSessionID

long getSessionID()

セッションIDを取得.

セッションIDを取得します.

戻り値:

long セッションIDが返されます.

setCharset

void setCharset(java.lang.String charset)

キャラクタセットを設定.

キャラクタセットを設定します.

パラメータ:

charset - 対象のキャラクタセットを設定します.

getCharset

java.lang.String getCharset()

キャラクタセットを取得.

キャラクタセットを取得します.

戻り値:

String キャラクタセットが返されます.

setMimeType

void setMimeType(java.lang.String mimeType)

Mimeタイプを設定.

Mimeタイプを設定します.

パラメータ:

mimeType - 対象のMimeタイプを設定します.

getMimeType

java.lang.String getMimeType()

Mimeタイプを取得.

Mimeタイプを取得します.

戻り値:

String Mimeタイプが返されます.

getOutputStream

java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

レスポンスにバイナリデータを出力する際に 使用するOutputStreamを取得.

レスポンスにバイナリデータを出力する際に 使用するOutputStreamを取得します.

戻り値:

OutputStream バイナリデータに出力する OutputStreamが返されます.

例外:

java.io.IOException - I/O例外.

getWriter

java.io.PrintWriter getWriter()
                              throws java.io.IOException

文字データをクライアントに送り返すのに 使用するPrintWriterオブジェクトを取得.

文字データをクライアントに送り返すのに 使用するPrintWriterオブジェクトを取得します.

戻り値:

PrintWriter クライアントに文字データを送り返すことが できるPrintWriterオブジェクトが返されます.

例外:

java.io.IOException - I/O例外.

isMode

boolean isMode()

データモードを取得.

確定しているデータモードを取得します.

戻り値:

boolean 確定しているデータモードが返されます.
[true]が返された場合、文字情報として送られます.
[false]が返された場合、バイナリ情報として送られます.

setSuccess

void setSuccess(int result)

正常戻り値を設定.

正常戻り値を設定します.

パラメータ:

result - 正常戻り値を設定します.

setWarning

void setWarning(int result)

警告戻り値を設定.

警告戻り値を設定します.

パラメータ:

result - 警告戻り値を設定します.

setError

void setError(int result)

異常戻り値を設定.

異常戻り値を設定します.

パラメータ:

result - 異常戻り値を設定します.

setError

void setError(int result,
              java.lang.String message)

異常戻り値を設定.

異常戻り値を設定します.

パラメータ:

result - 異常戻り値を設定します.

message - 異常メッセージを設定します.

setFatalError

void setFatalError(int result)

復旧不能異常戻り値を設定.

復旧不能異常戻り値を設定します.

パラメータ:

result - 復旧不能異常戻り値を設定します.

setFatalError

void setFatalError(int result,
                   java.lang.String message)

復旧不能異常戻り値を設定.

復旧不能異常戻り値を設定します.

パラメータ:

result - 復旧不能異常戻り値を設定します.

message - 復旧不能異常メッセージを設定します.

getResult

int getResult()

設定されている戻り値を取得.

設定されている戻り値を取得します.

戻り値:

int 設定されている戻り値が返されます.

getResultMessage

java.lang.String getResultMessage()

設定されている戻りメッセージを取得.

設定されている戻りメッセージを取得します.

戻り値:

String 設定されている戻りメッセージが返されます.