Top Description Methods
org.hibernate.procedure

public Interface ProcedureOutputs

extends Outputs
Known Direct Implementers
org.hibernate.procedure.internal.ProcedureOutputsImpl
Imports
org.hibernate.query.procedure.ProcedureParameter, org.hibernate.result.Outputs

Specialization of the Outputs contract providing access to the stored procedure's registered output parameters.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public <T> T

Returns:

The output value.
getOutputParameterValue
(ProcedureParameter<T>
The parameter's registration memento.
parameter
)

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

public Object

Returns:

The output value.
getOutputParameterValue
(String
The name under which the parameter was registered.
name
)

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

public Object

Returns:

The output value.
getOutputParameterValue
(int
The position at which the parameter was registered.
position
)

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

Inherited from org.hibernate.result.Outputs:
getCurrentgoToNextrelease

Method Detail

getOutputParameterValueback to summary
public <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:ProcedureParameter<T>

The parameter's registration memento.

Returns:T

The output value.

See Also
ProcedureCall#registerParameter(String, Class, jakarta.persistence.ParameterMode)
getOutputParameterValueback to summary
public Object getOutputParameterValue(String name)

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

Parameters
name:String

The name under which the parameter was registered.

Returns:Object

The output value.

Exceptions
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)
getOutputParameterValueback to summary
public Object getOutputParameterValue(int position)

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

Parameters
position:int

The position at which the parameter was registered.

Returns:Object

The output value.

Exceptions
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)