VistALink v1.6

gov.va.med.vistalink.adapter.record
Interface VistaLinkRequestVO

All Known Implementing Classes:
RpcRequest, VistaLinkRequestVOImpl

public interface VistaLinkRequestVO

Base request interface


Method Summary
 java.lang.String getRequestString()
          Returns request string that is written to the socket sent to MUMPS.
 VistaLinkRequestRetryStrategy getRetryStrategy()
          Returns current retry strategy reference.
 int getTimeOut()
          Returns time out value used for communications to M RPC server.
 void setRetryStrategy(VistaLinkRequestRetryStrategy strategy)
          Enables application to set retry strategy for request, to be used if request execution failed because of socket failure or other system type problems.
 void setTimeOut(int timeOut)
          Enables application to set a request-specific time out for read operations on the connection, for the request.
 

Method Detail

getRequestString

java.lang.String getRequestString()
                                  throws FoundationsException
Returns request string that is written to the socket sent to MUMPS.

Returns:
String represents the request to M
Throws:
FoundationsException
 
NOT FOR PUBLIC USE
This constructor, method or field is not for public use.

getTimeOut

int getTimeOut()
Returns time out value used for communications to M RPC server.

Returns:
int time out value in milli-seconds

setTimeOut

void setTimeOut(int timeOut)
Enables application to set a request-specific time out for read operations on the connection, for the request.

A timeout value of 0 (zero) indicates that no specific time out for the request is specified, and that the time out value associated with the socket should be used during socket read operations.

Parameters:
timeOut - Time out value to set in milli-seconds. This timeout value is compared to the default value usually used for the connection. The greater of the two values will be used.

getRetryStrategy

VistaLinkRequestRetryStrategy getRetryStrategy()
Returns current retry strategy reference.

Returns:
VistaLinkRequestRetryStrategy instance reference

setRetryStrategy

void setRetryStrategy(VistaLinkRequestRetryStrategy strategy)
Enables application to set retry strategy for request, to be used if request execution failed because of socket failure or other system type problems. The strategy determines if the retry should be attempted.

Parameters:
strategy - the VistaLinkRequestRetryStrategy instance representing the strategy the application wants implemented.

VistALink v1.6

VistALink v1.6