org.ibatis.persist.criteria.CriteriaDelete 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;

/**
 * The CriteriaDelete interface defines functionality for performing bulk delete operations using the
 * Criteria API
 *
 * 
 * Criteria API bulk delete operations map directly to database delete operations. The persistence context is not
 * synchronized with the result of the bulk delete.
 *
 * 
 * A CriteriaDelete object must have a single root.
 *
 * @param 
 *            the entity type that is the target of the delete
 *
 * @since iBatis Persistence 1.0
 */
public interface CriteriaDelete extends CommonAbstractCriteria, Parameterized> {

    /**
     * Create and add a query root corresponding to the entity that is the target of the delete. A
     * CriteriaDelete object has a single root, the entity that is being deleted.
     * 
     * @param entityClass
     *            the entity class
     * @return query root corresponding to the given entity
     */
    Root from(Class entityClass);

    /**
     * Return the query root.
     * 
     * @return the query root
     */
    Root getRoot();

    /**
     * Modify the delete query to restrict the target of the deletion according to the specified boolean expression.
     * Replaces the previously added restriction(s), if any.
     * 
     * @param restriction
     *            a simple or compound boolean expression
     * @return the modified delete query
     */
    CriteriaDelete where(Expression restriction);

    /**
     * Modify the delete query to restrict the target of the deletion according to the conjunction of the specified
     * restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified,
     * any previously added restrictions are simply removed.
     * 
     * @param restrictions
     *            zero or more restriction predicates
     * @return the modified delete query
     */
    CriteriaDelete where(Predicate... restrictions);

}