|
VistALink v1.6 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.va.med.vistalink.adapter.record.VistaLinkRequestVOImpl
gov.va.med.vistalink.rpc.RpcRequest
public class RpcRequest
Represents a RPC request to an M VistA server.
This is the principal class of VLJ used by developers to create and setup requests to the host M server.
J2SE Example:
//The Rpc Context
//The Rpc to call
//Construct the request object
//Execute the Rpc and get the response
//Work with the response ...
//request and response objects
RpcRequest vReq = null;
RpcResponse vResp = null;
String rpcContext = "XOBV VISTALINK TESTER";
String rpcName = "XOBV TEST PING";
vReq = RpcRequestFactory.getRpcRequest(rpcContext, rpcName);
vResp = myConnection.executeRPC(vReq);
Method Summary | |
---|---|
static java.lang.String |
buildMultipleMSubscriptKey(java.lang.String keyValue)
Builds and returns string that contains the following: an indicator that the value represents a multiple M subscript structure the actual multiple M subscript structure string value |
void |
clearParams()
Clears the params associated with this instance of RpcRequest |
RpcRequestParams |
getParams()
Gets the reference to the RpcRequestParams object associated with this request. |
java.lang.String |
getRequestString()
Gets the proprietary or xml (depending on setting) request string to be sent to the M server. |
int |
getRpcClientTimeOut()
Gets the current client time out value. |
java.lang.String |
getRpcContext()
Gets the name of the RPC Context. |
java.lang.String |
getRpcName()
Gets the name of the RPC. |
double |
getRpcVersion()
Gets the current RPC version specified by application |
boolean |
isUseProprietaryMessageFormat()
Deprecated. For internal testing only! |
boolean |
isXmlResponse()
Indicates whether the returned value from the RPC call is expected in XML format or not. |
void |
setParams(java.util.List list)
Sets all the parameters for a RPC call at once using a List. |
void |
setReAuthenticateInfo(gov.va.med.vistalink.adapter.cci.VistaLinkConnectionSpecImpl connSpec,
gov.va.med.vistalink.adapter.spi.EMReAuthState reAuthState,
gov.va.med.vistalink.adapter.spi.EMAdapterEnvironment theAdapterEnvironment)
|
void |
setRpcClientTimeOut(int value)
Sets the client time out value. |
void |
setRpcContext(java.lang.String value)
Sets the name of the RPC Context to be used. |
void |
setRpcName(java.lang.String value)
Sets the name of the RPC to be called on the M server. |
void |
setRpcVersion(double value)
Sets the RPC version number Note: Like parameters, it is up to the application code to set this property appropriately for each RPC request made using the RpcRequest instance. |
void |
setUseProprietaryMessageFormat(boolean useSink)
Set the indicator that the RPC request should be sent to the M server in a proprietary format (true) or in XML format (false). |
void |
setXmlResponse(boolean value)
Sets the indicator that the returned value from the RPC call is expected in XML format or not. |
Methods inherited from class gov.va.med.vistalink.adapter.record.VistaLinkRequestVOImpl |
---|
getRetryStrategy, getTimeOut, setRetryStrategy, setTimeOut |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public RpcRequestParams getParams()
RpcRequestParams
object associated with this request.
This object contains the parameters sent with the call to the RPC during the getResponse() call. Use this object to set these parameters before calling getResponse().
public void setParams(java.util.List list)
list
- public static java.lang.String buildMultipleMSubscriptKey(java.lang.String keyValue)
keyValue
- Value representing the multiple M subscript structure
public void clearParams()
public java.lang.String getRpcName()
public void setRpcName(java.lang.String value)
value
- public java.lang.String getRpcContext()
public void setRpcContext(java.lang.String value)
value
- public int getRpcClientTimeOut()
public void setRpcClientTimeOut(int value)
value
- public double getRpcVersion()
public void setRpcVersion(double value)
value
- The RPC version to set.public java.lang.String getRequestString() throws FoundationsException
getRequestString
in interface VistaLinkRequestVO
getRequestString
in class VistaLinkRequestVOImpl
FoundationsException
public boolean isXmlResponse()
public void setXmlResponse(boolean value)
value
- Whether XML is the expected type of result to be returned.public boolean isUseProprietaryMessageFormat()
public void setUseProprietaryMessageFormat(boolean useSink)
useSink
- public void setReAuthenticateInfo(gov.va.med.vistalink.adapter.cci.VistaLinkConnectionSpecImpl connSpec, gov.va.med.vistalink.adapter.spi.EMReAuthState reAuthState, gov.va.med.vistalink.adapter.spi.EMAdapterEnvironment theAdapterEnvironment)
connSpec
- reAuthState
- theAdapterEnvironment
- This constructor, method or field is not for public use. |
|
VistALink v1.6 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |