|
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.VistaLinkResponseVOImpl
gov.va.med.vistalink.rpc.RpcResponse
public class RpcResponse
Represents a data structure which holds the response value(s).
It is extremely important that any code which might create a new RpcResponse be encased in a try catch block so that VistaLinkfaultException and FoundationsException can be caught.
J2SE Example:
//The Rpc Context
//The Rpc to call
//Construct the request object
//Execute the Rpc and get the response
//Display 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);
System.out.println(vResp.getRawResponse());
Method Summary | |
---|---|
java.lang.String |
getResults()
Gets the results string for the returned data in this response. |
org.w3c.dom.Document |
getResultsDocument()
Gets an XML Document format based on the contains of the results returned by the RPC. |
java.lang.String |
getResultsType()
Gets the return type of the results sent back from the M VistAServer. |
void |
setResultsType(java.lang.String resultsType)
Sets the resultsType. |
Methods inherited from class gov.va.med.vistalink.adapter.record.VistaLinkResponseVOImpl |
---|
getDocument, getFilteredXml, getRawResponse |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public org.w3c.dom.Document getResultsDocument() throws RpcResponseTypeIsNotXmlException, FoundationsException
Note: This XML document is created during the call to this method and not as part of the creation of the RpcResponse object.
If calling application wants to use this method, it should use generic xml DOM interfaces from org.w3c.dom.* package.
Alternatively if application wants to use this document in a specific XML parser implementation, parser should be able to create a specific Document implementation from org.w3c.dom.Document interface. In this case it might be better from performance standpiont to use getResults() and parse xml string directly.
RpcResponseTypeIsNotXmlException
- results type must be 'xml'
FoundationsException
public java.lang.String getResults()
public java.lang.String getResultsType()
public void setResultsType(java.lang.String resultsType)
resultsType
- The resultsType to setThis 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 |