Interface ProcedureOutputs

All Superinterfaces:

AutoCloseable

public interface ProcedureOutputs
extends AutoCloseable

Represents the outputs of executing a JDBC statement. Provides support for accessing result-sets, update counts, and registered output parameters.

Method Summary

Modifier and Type	Method	Description
default void	close()
Output	getCurrent()	Retrieve the current Output object.
Object	getOutputParameterValue(int position)	Retrieve the value of an OUTPUT parameter by the name position under which the parameter was registered.
Object	getOutputParameterValue(String name)	Retrieve the value of an OUTPUT parameter by the name under which the parameter was registered.
<T> T	getOutputParameterValue(ProcedureParameter<T> parameter)	Retrieve the value of an OUTPUT parameter by the parameter's registration memento.
boolean	goToNext()	Go to the next Output object (if any), returning an indication of whether there is another.
void	release()	Eagerly release any held resources.

Method Details

getOutputParameterValue

<T> T getOutputParameterValue(ProcedureParameter<T> parameter)

Retrieve the value of an OUTPUT parameter by the parameter's registration memento.

Should NOT be called for parameters registered as REF_CURSOR. REF_CURSOR parameters should be accessed via the returns (see goToNext()).

Parameters:

parameter - The parameter's registration memento.

Returns:

The output value.

See Also:

• ProcedureCall.registerParameter(String, Class, jakarta.persistence.ParameterMode)

getOutputParameterValue

Object getOutputParameterValue(String name)

Retrieve the value of an OUTPUT parameter by the name under which the parameter was registered.

Should NOT be called for parameters registered as REF_CURSOR. REF_CURSOR parameters should be accessed via the returns (see goToNext()).

Parameters:

name - The name under which the parameter was registered.

Returns:

The output value.

Throws:

ParameterStrategyException - If the ProcedureCall is defined using positional parameters

NoSuchParameterException - If no parameter with that name exists

See Also:

• ProcedureCall.registerParameter(String, Class, jakarta.persistence.ParameterMode)

getOutputParameterValue

Object getOutputParameterValue(int position)

Retrieve the value of an OUTPUT parameter by the name position under which the parameter was registered.

Should NOT be called for parameters registered as REF_CURSOR. REF_CURSOR parameters should be accessed via the returns (see goToNext()).

Parameters:

position - The position at which the parameter was registered.

Returns:

The output value.

Throws:

ParameterStrategyException - If the ProcedureCall is defined using named parameters

NoSuchParameterException - If no parameter with that position exists

See Also:

• ProcedureCall.registerParameter(int, Class, jakarta.persistence.ParameterMode)

getCurrent

Output getCurrent()

Retrieve the current Output object.

Returns:

The current Output object. Can be null

goToNext

boolean goToNext()

Go to the next Output object (if any), returning an indication of whether there is another.

Returns:

true if the next call to getCurrent() will return a non-null value.

release

void release()

Eagerly release any held resources.

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception