gov.va.med.vistalink.rpc.RpcRequest    ICR (5242)

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

Represents a RPC request to an M VistA server.

This is the principal class for use by developers to create and setup requests
to the host M server.
STATUS Active
KEYWORDS vistalink
DURATION Till Otherwise Agreed
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
buildMultipleMSubscriptKey
public 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.
VARIABLES TYPE VARIABLES DESCRIPTION
keyValue Input
java.lang.String keyValue: Value representing the
multiple M subscript structure.
return Output
returns java.lang.String: flagged key value to be
used as HashMap key.
getParams
public gov.va.med.vistalink.rpc.RpcRequestParams
getParams(): Gets the reference to the RpcRequestParamsobject 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().
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns gov.va.med.vistalink.rpc.RpcRequestParams
containing the parameters to send with the request.
setParams
public void setParams(java.util.List list): Sets all
the parameters for a RPC call at once using a List.
VARIABLES TYPE VARIABLES DESCRIPTION
list Input
java.util.List list: list of parameters for the RPC
call.
clearParams
public void clearParams(): Clears the params
associated with this instance of RpcRequest
getRpcName
public java.lang.String getRpcName(): Gets the name
of the RPC.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String: name of the RPC associated
with the request.
setRpcName
public void setRpcName(java.lang.String value): Sets
the name of the RPC to be called on the M server. The name must be a valid RPC
name as it appears in the REMOTE PROCEDURE (#8994) file in M VistA.
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
java.lang.String value: name of the RPC to be called
on the M server. The name must be a valid RPC name as it appears in the REMOTE
PROCEDURE (#8994) file in M VistA.
getRpcContext
public java.lang.String getRpcContext(): Gets the
name of the RPC Context.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String name of the RPC context
associated with the request.
setRpcContext
public void setRpcContext(java.lang.String value):
Sets the name of the RPC Context to be used. The name must be a valid B- type
OPTION name as it appears in the OPTION (#19) file in M VistA.
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
java.lang.String value: the name of the RPC Context
to be used. The name must be a valid B- type OPTION name as it appears in the
OPTION (#19) file in M VistA.
getRpcClientTimeOut
public int getRpcClientTimeOut(): Gets the current
client time out value. (Value is returned in the number of seconds).
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns int: the current client time out value.
(Value is returned in the number of seconds).
setRpcClientTimeOut
public void setRpcClientTimeOut(int value): Sets the
client time out value. (Value is expected in seconds.)
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
int value: client time out value. (Value is expected
in seconds.)
getRpcVersion
public double getRpcVersion(): Gets the current RPC
version specified by application.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns double: the rpcVersion specified in the
request.
setRpcVersion
public 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. To unset to default, set property to 0 (zero).
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
double value: 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. To
unset to default, set property to 0 (zero).
getRequestString
public java.lang.String getRequestString() throws
FoundationsException: Gets the proprietary request string
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String: returns the proprietary or
xml (depending on setting) request string to be sent to the M server.
throws Output
throws

gov.va.med.exception.FoundationsException: thrown if a failure is encountered
creating request string from the request.
isXmlResponse
public boolean isXmlResponse(): Indicates whether the
returned value from the RPC call is expected in XML format or not.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns boolean: true or false depending on whether
request has been set with indicator that result is expected in XML format.
setXmlResponse
public void setXmlResponse(boolean value): Sets
request indicator that the returned value from the RPC call is expected in XML
format or not.
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
boolean value: Whether XML is the expected type of
result to be returned.
setUseProprietaryMessageFormat
public 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).
VARIABLES TYPE VARIABLES DESCRIPTION
useSink Input
boolean useSink: the RPC request should be sent to
the M server in a proprietary format (true) or in XML format (false).
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 05, 2018@ IA Listing Descriptions