si.ijs.acs.objectexplorer.engine

Interface RemoteResponse

All Known Implementing Classes:

BACIRemoteResponse

public interface RemoteResponse

A data structure representing an asynchronous notification (monitor, callback, alarm). The structure contains the name of the method invoked by the server and all the parameters passed by the server.

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getData() Returns the data passed by the server to the client in the asynchronous calls.
java.lang.String[]	getDataNames() Returns the names of the parameter values stored in the corresponding data array.
Invocation	getInvocation() Returns the Invocation object that caused this response to be generated.
java.lang.String	getName() Returns the name of the callback method invoked by the server.
int	getSequenceNumber() Returns a unique response sequence number of this response.
long	getTimestamp() Return timestamp of the response.
boolean	isErrorResponse() Returns true if, during the invocation of this method, the engine determined that the remote object responded with error completion.

Method Detail

getData

java.lang.Object[] getData()

Returns the data passed by the server to the client in the asynchronous calls. The names of the parameters are passed in the corresponding dataNames array.

Returns:

array of callback parameters

getDataNames

java.lang.String[] getDataNames()

Returns the names of the parameter values stored in the corresponding data array.

Returns:

parameter names, used to display the values

getInvocation

Invocation getInvocation()

Returns the Invocation object that caused this response to be generated.

Returns:

Invocation that represents the remote process generating these responses

getName

java.lang.String getName()

Returns the name of the callback method invoked by the server. This name will be interpreted as the asynchronous "message" or "event", accompanied by the data array.

Returns:

name of the asynchronous message

getSequenceNumber

int getSequenceNumber()

Returns a unique response sequence number of this response.

Returns:

SeqN

isErrorResponse

boolean isErrorResponse()

Returns true if, during the invocation of this method, the engine determined that the remote object responded with error completion.

Returns:

true if the method invocation was completed with error

getTimestamp

long getTimestamp()

Return timestamp of the response. Engine should use server timestamp that correspond to the data timestamp. If not available System.currentTimeMillis() should be used.

Returns:

timestamp of the response.