org.hibernate.type

Interface ProcedureParameterExtractionAware<T>

All Known Implementing Classes:

AbstractSingleColumnStandardBasicType, AbstractStandardBasicType, AdaptedImmutableType, AttributeConverterTypeAdapter, BigDecimalType, BigIntegerType, BinaryType, BlobType, BooleanType, ByteType, CalendarDateType, CalendarTimeType, CalendarType, CharacterArrayClobType, CharacterArrayNClobType, CharacterArrayType, CharacterNCharType, CharacterType, CharArrayType, ClassType, ClobType, ComponentType, CurrencyType, CustomType, DateType, DbTimestampType, DoubleType, DurationType, EmbeddedComponentType, FloatType, ImageType, InstantType, IntegerType, LocalDateTimeType, LocalDateType, LocaleType, LocalTimeType, LongType, MaterializedBlobType, MaterializedClobType, MaterializedNClobType, NClobType, NTextType, NumericBooleanType, OffsetDateTimeType, OffsetTimeType, PostgresUUIDType, PrimitiveCharacterArrayClobType, PrimitiveCharacterArrayNClobType, RowVersionType, SerializableToBlobType, SerializableType, ShortType, StandardBasicTypeTemplate, StringNVarcharType, StringType, TextType, TimestampType, TimeType, TimeZoneType, TrueFalseType, UrlType, UUIDBinaryType, UUIDCharType, WrappedMaterializedBlobType, WrapperBinaryType, YesNoType, ZonedDateTimeType

public interface ProcedureParameterExtractionAware<T>

Optional Type contract for implementations that are aware of how to extract values from store procedure OUT/INOUT parameters.

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
boolean	canDoExtraction() Can the given instance of this type actually perform the parameter value extractions?
T	extract(CallableStatement statement, int startIndex, SharedSessionContractImplementor session) Perform the extraction
T	extract(CallableStatement statement, String[] paramNames, SharedSessionContractImplementor session) Perform the extraction

Method Detail

canDoExtraction

boolean canDoExtraction()

Can the given instance of this type actually perform the parameter value extractions?

Returns:

true indicates that @{link #extract} calls will not fail due to IllegalStateException.

extract

T extract(CallableStatement statement,
          int startIndex,
          SharedSessionContractImplementor session)
   throws SQLException

Perform the extraction

Parameters:

statement - The CallableStatement from which to extract the parameter value(s).

startIndex - The parameter index from which to start extracting; assumes the values (if multiple) are contiguous

session - The originating session

Returns:

The extracted value.

Throws:

SQLException - Indicates an issue calling into the CallableStatement

IllegalStateException - Thrown if this method is called on instances that return false for canDoExtraction()

extract

T extract(CallableStatement statement,
          String[] paramNames,
          SharedSessionContractImplementor session)
   throws SQLException

Perform the extraction

Parameters:

statement - The CallableStatement from which to extract the parameter value(s).

paramNames - The parameter names.

session - The originating session

Returns:

The extracted value.

Throws:

SQLException - Indicates an issue calling into the CallableStatement

IllegalStateException - Thrown if this method is called on instances that return false for canDoExtraction()