Print Page as PDF
gov.va.med.vistalink.rpc.RpcResponse ICR (5241)

gov.va.med.vistalink.rpc.RpcResponse    ICR (5241)

Name Value
NUMBER 5241
IA # 5241
DATE CREATED 2008/07/03
CUSTODIAL PACKAGE VISTALINK
USAGE Supported
TYPE Other
DBIC APPROVAL STATUS APPROVED
NAME gov.va.med.vistalink.rpc.RpcResponse
GENERAL DESCRIPTION
public class RpcResponse extends
gov.va.med.vistalink.adapter.record.VistaLinkResponseVOImpl.

Represents a data structure which holds the response value(s).
STATUS Active
KEYWORDS vistalink
DURATION Till Otherwise Agreed
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
getResultsDocument
public org.w3c.dom.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.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns org.w3c.dom.Document
throws Output
Throws

gov.va.med.vistalink.rpc.RpcResponseTypeIsNotXmlException: results type must
be 'xml'

gov.va.med.exception.FoundationsException: thrown if problem generating xml
DOM document from results string.
getResults
public java.lang.String getResults(): Gets the
results string for the returned data in this response.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String: results string for the
returned data in this response.
getResultsType
public java.lang.String getResultsType(): gets the
return type of the results sent back from the M VistAServer. The possible
types are 'string' or 'array'.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String: return type of the results
sent back from the M VistAServer, either 'string' or 'array'.
CREATOR CLARKE,KYLE E
DATE ACTIVATED 2008/07/11
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF
2009/12/16 14:53 APPROVED CLARKE,KYLE
Generated from SEP 10, 2019@ IA Listing Descriptions