VistALink v1.6

gov.va.med.vistalink.adapter.record
Class VistaLinkRequestVOImpl

java.lang.Object
  extended by gov.va.med.vistalink.adapter.record.VistaLinkRequestVOImpl
All Implemented Interfaces:
VistaLinkRequestVO
Direct Known Subclasses:
RpcRequest

public class VistaLinkRequestVOImpl
extends java.lang.Object
implements VistaLinkRequestVO

Base request implementation. Applications usually use a specific subclass of this implementation.


Constructor Summary
VistaLinkRequestVOImpl()
          Constructor for VistaLinkRequestVOImpl.
VistaLinkRequestVOImpl(org.w3c.dom.Document requestDoc)
          Constructor for VistaLinkRequestVOImpl.
 
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 retryStrategy)
          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.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VistaLinkRequestVOImpl

public VistaLinkRequestVOImpl()
Constructor for VistaLinkRequestVOImpl.

See Also:
Object.Object()
 
NOT FOR PUBLIC USE
This constructor, method or field is not for public use.

VistaLinkRequestVOImpl

public VistaLinkRequestVOImpl(org.w3c.dom.Document requestDoc)
Constructor for VistaLinkRequestVOImpl.

Parameters:
requestDoc -
 
NOT FOR PUBLIC USE
This constructor, method or field is not for public use.
Method Detail

getRequestString

public java.lang.String getRequestString()
                                  throws FoundationsException
Description copied from interface: VistaLinkRequestVO
Returns request string that is written to the socket sent to MUMPS.

Specified by:
getRequestString in interface VistaLinkRequestVO
Returns:
String represents the request to M
Throws:
FoundationsException

getTimeOut

public int getTimeOut()
Description copied from interface: VistaLinkRequestVO
Returns time out value used for communications to M RPC server.

Specified by:
getTimeOut in interface VistaLinkRequestVO
Returns:
int time out value in milli-seconds

setTimeOut

public void setTimeOut(int timeOut)
Description copied from interface: VistaLinkRequestVO
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.

Specified by:
setTimeOut in interface VistaLinkRequestVO
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

public VistaLinkRequestRetryStrategy getRetryStrategy()
Description copied from interface: VistaLinkRequestVO
Returns current retry strategy reference.

Specified by:
getRetryStrategy in interface VistaLinkRequestVO
Returns:
VistaLinkRequestRetryStrategy instance reference

setRetryStrategy

public void setRetryStrategy(VistaLinkRequestRetryStrategy retryStrategy)
Description copied from interface: VistaLinkRequestVO
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.

Specified by:
setRetryStrategy in interface VistaLinkRequestVO
Parameters:
retryStrategy - the VistaLinkRequestRetryStrategy instance representing the strategy the application wants implemented.

VistALink v1.6

VistALink v1.6