com.ibm.ims.dli

Interface PreparedValue

public interface PreparedValue

Interface used for storing and setting a prepared value. This is useful when when the value to set in an SSA is not known until runtime. The application can create a SSAList initially and then set the PreparedValue with the appropriate value once it is known. This also results in the ability to reuse an SSA (and therefore an SSAList) several times throughout the course of an application by simply changing the value in the PreparedValue object.

The following code fragment, in which ssaList is a valid SSAList object, illustrates how to create and use a PreparedValue.

 // create a placeholder for the HOSPCODE field
 PreparedValue pv = ssaList.createPreparedValue("HOSPCODE");  
   
 // insert the placeholder in the qualification
 ssaList.addInitialQualification("HOSPITAL", "HOSPCODE", SSAList.EQUALS, pv);  
 ...
 // insert the value 123 for HOSPCODE in the SSA list
 pv.setValue("123");  
 Path path = ssaList.getPathForRetrieveReplace();
   
 // issue the DLI call
 pcb.getUnique(path, ssaList, false);
 

See Also:

SSAList.createPreparedValue(String), SSAList.getPreparedValue(String), SSAList.getPreparedValues()

Method Summary

Modifier and Type	Method and Description
String	getName() Retrieves the name of the prepared value.
Object	getValue() Gets the value of the prepared value parameter as an java.lang.Object.
void	setValue(Object value) Sets the value of the prepared value parameter using the given object.

Method Detail

getName

String getName()

Retrieves the name of the prepared value. Typically the name is the name of the field the prepared value parameter is referring to.

Returns:

the name of the prepared value

setValue

void setValue(Object value)

Sets the value of the prepared value parameter using the given object.

Parameters:

value - the value of the designated prepared value parameter

getValue

Object getValue()

Gets the value of the prepared value parameter as an java.lang.Object.

Returns:

the value of the prepared value parameter