org.ibatis.persist.criteria

Interface Parameterized<E>

All Known Subinterfaces:

CriteriaDelete<T>, CriteriaQuery<T>, CriteriaUpdate<T>

public interface Parameterized<E>

Parameterized

Since:

iBatis Persistence 1.0

Method Summary

Modifier and Type	Method and Description
Parameter<?>	getParameter(String name) Get the parameter object corresponding to the declared parameter of the given name.
<R> Parameter<R>	getParameter(String name, Class<R> type) Get the parameter object corresponding to the declared parameter of the given name and type.
Set<? extends Parameter<?>>	getParameters() Get the parameter objects corresponding to the declared parameters of the query.
<R> R	getParameterValue(Parameter<R> param) Return the input value bound to the parameter.
<R> R	getParameterValue(String name) Return the input value bound to the named parameter.
boolean	isBound(Parameter<?> param) Return a boolean indicating whether a value has been bound to the parameter.
<R> E	setParameter(int position, R value) Bind an argument value to a positional parameter.
<R> E	setParameter(Parameter<R> param, R value) Bind the value of a Parameter object.
<R> E	setParameter(String name, R value) Bind an argument value to a named parameter.

Method Detail

setParameter

<R> E setParameter(Parameter<R> param,
                   R value)

Bind the value of a Parameter object.

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

Since:

iBatis Persistence 1.0

setParameter

<R> E setParameter(String name,
                   R value)

Bind an argument value to a named parameter.

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

setParameter

<R> E setParameter(int position,
                   R value)

Bind an argument value to a positional parameter.

Parameters:

position - position

value - parameter value

Returns:

the same query instance

getParameters

Set<? extends Parameter<?>> getParameters()

Get the parameter objects corresponding to the declared parameters of the query. Returns empty set if the query has no parameters. This method is not required to be supported for native queries.

Returns:

set of the parameter objects

getParameter

Parameter<?> getParameter(String name)

Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.

Parameters:

name - parameter name

Returns:

parameter object

getParameter

<R> Parameter<R> getParameter(String name,
                              Class<R> type)

Get the parameter object corresponding to the declared parameter of the given name and type. This method is required to be supported for criteria queries only.

Parameters:

name - parameter name

type - type

Returns:

parameter object

isBound

boolean isBound(Parameter<?> param)

Return a boolean indicating whether a value has been bound to the parameter.

Parameters:

param - parameter object

Returns:

boolean indicating whether parameter has been bound

getParameterValue

<R> R getParameterValue(Parameter<R> param)

Return the input value bound to the parameter. (Note that OUT parameters are unbound.)

Parameters:

param - parameter object

Returns:

parameter value

getParameterValue

<R> R getParameterValue(String name)

Return the input value bound to the named parameter. (Note that OUT parameters are unbound.)

Parameters:

name - parameter name

Returns:

parameter value