Passing Parameters from the Client

PV-WAVE Advantage > JWAVE User Guide > JWAVE Client Development > Passing Parameters from the Client

The JWaveExecute.setParam method is used to pack parameters and data on the client to be sent to the server. The basic information that is packed by setParam includes a parameter name and some kind of reference to data.

Overloaded versions of setParam are provided for your convenience in specifying this parameter information.

For example, some of the setParam configurations are:

setParam(String name, double value)

Associates a parameter name with a scalar numeric primitive value. This method accepts any primitive numeric scalar value.

note	Parameter names are not case sensitive; they must begin with a letter, and can contain only letters, digits, and underscores.

setParam(String name, Object value)

Associates a parameter name with a scalar or array. The valid data types you can use with this setParam method include:

Scalar Values:

numeric Objects (standard subclasses of Number, such as Integer), except Long

String

Arrays of up to eight dimensions of:

numeric Objects (such as Integer)

numeric primitives (such as int), except long

String

A Proxy object referring to one of the above types. (See Chapter 6: Managing Data for more information on proxies.)

setParam(Parameter param)

Sets a previously defined Parameter object (which encapsulates the parameter name and associated data).

There are several other methods for setParam. Some of these are discussed in Chapter 6: Managing Data. Others are not commonly used, and are not discussed in this manual. Refer to the Javadoc reference on the JWaveExecute class for detailed information on all of the setParam methods. For information on Javadoc, see "Using the JWAVE Javadoc Reference".

As you can see, the different permutations of setParam allow you to specify precisely how you want parameters to be sent to the client. No matter how this parameter information is specified, setParam “packs” the parameter information in a uniform manner so that the server can retrieve and unpack the parameters.

On the server side, the function GETPARAM is used to unpack the parameters so that they can be used by PV‑WAVE.