gov.va.med.vistalink.rpc

Class RpcResponse

Object

VistaLinkResponseVOImpl

RpcResponse

All Implemented Interfaces:

VistaLinkResponseVO

public class RpcResponse
extends VistaLinkResponseVOImpl

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:

//request and response objects
RpcRequest vReq = null;
RpcResponse vResp = null;

//The Rpc Context
String rpcContext = "XOBV VISTALINK TESTER";

//The Rpc to call
String rpcName = "XOBV TEST PING";

//Construct the request object
vReq = RpcRequestFactory.getRpcRequest(rpcContext, rpcName);

//Execute the Rpc and get the response
vResp = myConnection.executeRPC(vReq);

//Display the response
System.out.println(vResp.getRawResponse());

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	GOV_VA_MED_FOUNDATIONS_FAULT The message type used to indicate a system/foundations fault
protected static String	GOV_VA_MED_FOUNDATIONS_SECURITY_FAULT The message type used to indicate a security fault
protected static String	GOV_VA_MED_RPC_FAULT The message type used to indicate RPC fault
protected static String	GOV_VA_MED_RPC_RESPONSE The message type used for this response

Fields inherited from class VistaLinkResponseVOImpl

filteredXml, msgType, rawXml, xdoc

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RpcResponse(String rawXml, String filteredXml, Document doc, String messageType, String cdataFromXml, String resultsType) Constructor RpcResponse.

Method Summary

Modifier and Type	Method and Description
String	getResults() Gets the results string for the returned data in this response.
Document	getResultsDocument() Gets an XML Document format based on the contains of the results returned by the RPC.
String	getResultsType() Gets the return type of the results sent back from the M VistAServer.
void	setResultsType(String resultsType) Sets the resultsType.

Methods inherited from class VistaLinkResponseVOImpl

getDocument, getFilteredXml, getRawResponse

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GOV_VA_MED_RPC_RESPONSE

protected static final String GOV_VA_MED_RPC_RESPONSE

The message type used for this response

See Also:

Constant Field Values

GOV_VA_MED_RPC_FAULT

protected static final String GOV_VA_MED_RPC_FAULT

The message type used to indicate RPC fault

See Also:

Constant Field Values

GOV_VA_MED_FOUNDATIONS_FAULT

protected static final String GOV_VA_MED_FOUNDATIONS_FAULT

The message type used to indicate a system/foundations fault

See Also:

Constant Field Values

GOV_VA_MED_FOUNDATIONS_SECURITY_FAULT

protected static final String GOV_VA_MED_FOUNDATIONS_SECURITY_FAULT

The message type used to indicate a security fault

See Also:

Constant Field Values

Constructor Detail

RpcResponse

protected RpcResponse(String rawXml,
                      String filteredXml,
                      Document doc,
                      String messageType,
                      String cdataFromXml,
                      String resultsType)

Constructor RpcResponse.

Parameters:

rawXml -

filteredXml -

doc -

messageType -

cdataFromXml -

resultsType -

Method Detail

getResultsDocument

public Document getResultsDocument()
                            throws RpcResponseTypeIsNotXmlException,
                                   FoundationsException

Gets an XML Document format based on the contains of the results returned by the RPC.

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.

Returns:

org.w3c.dom.Document

Throws:

RpcResponseTypeIsNotXmlException - results type must be 'xml'

FoundationsException

getResults

public String getResults()

Gets the results string for the returned data in this response.

Returns:

String

getResultsType

public String getResultsType()

Gets the return type of the results sent back from the M VistAServer. At the present time (04/2002) the possible types are 'string' or 'array'.

Returns:

String

setResultsType

public void setResultsType(String resultsType)

Sets the resultsType.

Parameters:

resultsType - The resultsType to set