org.eclipse.smila.ipc

Interface IpcResponse

public interface IpcResponse

base interface for IPC responses.

Author:

aweber

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Signals that we are finished with this response.
java.lang.String	getMessage()
java.lang.Object	getNext() throws UnsupportedOperationException if not implemented by this response implementation.
java.lang.Object	getResult() throws UnsupportedOperationException if not implemented by this response implementation.
java.io.InputStream	getStream() throws UnsupportedOperationException if not implemented by this response implementation.
void	initialize(java.lang.Object o) initialize the request with the response object from the server.
boolean	isStreamable()
boolean	isSuccess()

Method Detail

isStreamable

boolean isStreamable()

Returns:

true if the response is streamable.

getNext

java.lang.Object getNext()

throws UnsupportedOperationException if not implemented by this response implementation.

Returns:

next result object, or null if the end has been reached.

getResult

java.lang.Object getResult()

throws UnsupportedOperationException if not implemented by this response implementation.

Returns:

complete result at once.

getStream

java.io.InputStream getStream()

throws UnsupportedOperationException if not implemented by this response implementation.

Returns:

the base stream.

isSuccess

boolean isSuccess()

Returns:

true if the response represents the result of a successful request.

getMessage

java.lang.String getMessage()

Returns:

a description about the result state, e.g. an error message.

initialize

void initialize(java.lang.Object o)

initialize the request with the response object from the server.

Parameters:

o - original response object, e.g. an input stream.

close

void close()

Signals that we are finished with this response. Used to free resources.