gov.va.med.vistalink.rpc

Class RpcRequestParams

Object

RpcRequestParams

public class RpcRequestParams
extends Object

Represents the collection of parameters associated with an RPC.

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 STRING";

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

//clear the params
vReq.clearParams();

//Set the params
vReq.getParams(). setParam(1, "string", "This is a test string!");

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

//Work with the response ...

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RpcRequestParams() Constructs the Rpc Params.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the parameters.
Object	getParam(int position) Gets the value for a parameter associated with a specified position in the parameters collection.
protected HashMap	getParams() Returns the params node.
void	setParam(int position, String type, Object value) Sets a parameter needed by for a M RPC call.

Methods inherited from class Object

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

Constructor Detail

RpcRequestParams

protected RpcRequestParams()

Constructs the Rpc Params.

Method Detail

getParams

protected HashMap getParams()

Returns the params node.

Returns:

Node

clear

public void clear()

Clears the parameters.

getParam

public Object getParam(int position)

Gets the value for a parameter associated with a specified position in the parameters collection. Normally, this method is not used by the client.

Parameters:

position - parameter position the M RPC expects this parameter

Returns:

Object String or Map. A return value of null indicates that there is no parameter for the position.

setParam

public void setParam(int position,
                     String type,
                     Object value)

Sets a parameter needed by for a M RPC call.

The position argument is the parameter list position where the RPC expects to see this argument.

The type argument indicates to VistALink how the argument should be processed on the M VistA server.

Possible values are the following:

• string (corresponds to 'Literal' in VA RPC Broker)
• array (corresponds to 'List' in VA RPC Broker)
• ref (corresponds to 'Reference' in VA RPC Broker)

Parameters:

position - parameter position the M RPC expects this parameter

type - type of parameter corresponding to valid M RPC types

value - value of parameter