org.ibatis.persist.criteria.Parameterized Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbatis Show documentation

The jBATIS persistence framework will help you to significantly reduce the amount of Java code that you normally need to access a relational database. iBATIS simply maps JavaBeans to SQL statements using a very simple XML descriptor.

The newest version!

package org.ibatis.persist.criteria;

import java.util.Set;

import org.ibatis.persist.Parameter;

/**
 * Parameterized
 * 
 * @since iBatis Persistence 1.0
 */
public interface Parameterized {
    
    /**
     * Bind the value of a Parameter object.
     * 
     * @param param
     *            parameter object
     * @param value
     *            parameter value
     * @return the same query instance
     * @since iBatis Persistence 1.0
     */
     E setParameter(Parameter param, R value);

    /**
     * Bind an argument value to a named parameter.
     * 
     * @param name
     *            parameter name
     * @param value
     *            parameter value
     * @return the same query instance
     */
     E setParameter(String name, R value);

    /**
     * Bind an argument value to a positional parameter.
     * 
     * @param position
     *            position
     * @param value
     *            parameter value
     * @return the same query instance
     */
     E setParameter(int position, R value);

    /**
     * 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.
     * 
     * @return set of the parameter objects
     */
    Set> getParameters();

    /**
     * Get the parameter object corresponding to the declared parameter of the given name. This method is not required
     * to be supported for native queries.
     * 
     * @param name
     *            parameter name
     * @return parameter object
     */
    Parameter getParameter(String name);

    /**
     * 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.
     * 
     * @param name
     *            parameter name
     * @param type
     *            type
     * @return parameter object
     */
     Parameter getParameter(String name, Class type);

    /**
     * Return a boolean indicating whether a value has been bound to the parameter.
     * 
     * @param param
     *            parameter object
     * @return boolean indicating whether parameter has been bound
     */
    boolean isBound(Parameter param);

    /**
     * Return the input value bound to the parameter. (Note that OUT parameters are unbound.)
     * 
     * @param param
     *            parameter object
     * @return parameter value
     */
     R getParameterValue(Parameter param);

    /**
     * Return the input value bound to the named parameter. (Note that OUT parameters are unbound.)
     * 
     * @param name
     *            parameter name
     * @return parameter value
     */
     R getParameterValue(String name);

}