org.eclipse.osbp.dsl.dto.lib/src/org/eclipse/osbp/dsl/dto/lib/services/jpa/metadata/QueryModifierDelegate.java

/**
 * Copyright 2009-2013 Oy Vaadin Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.eclipse.osbp.dsl.dto.lib.services.jpa.metadata;

import java.io.Serializable;
import java.util.List;
import java.util.logging.Filter;

import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.CriteriaQuery;
import javax.persistence.criteria.Order;
import javax.persistence.criteria.Predicate;

import org.eclipse.osbp.dsl.dto.lib.services.SortBy;

/**
 * The QueryModifierDelegate interface defines methods that will be called at
 * the different stages of {@link CriteriaQuery} generation. Implement this
 * interface and call
 * {@link EntityDelegate#setQueryModifierDelegate(QueryModifierDelegate)} to
 * receive calls while the {@link CriteriaQuery} is being built. The methods are
 * allowed to modify the CriteriaQuery.
 * 
 * @since 2.0
 */
public interface QueryModifierDelegate extends Serializable {
    /**
     * This method is called after the {@link CriteriaQuery} instance (
     * <code>query</code>) has been instantiated, but before any state has been
     * set.
     * 
     * Operations and configuration may be performed on the query instance.
     * 
     * @param criteriaBuilder
     *            the {@link CriteriaBuilder} used to build the query
     * @param query
     *            the {@link CriteriaQuery} being built
     */
    public void queryWillBeBuilt(CriteriaBuilder criteriaBuilder,
            CriteriaQuery<?> query);

    /**
     * This method is called after the {@link CriteriaQuery} instance has been
     * completely built (configured).
     * 
     * Any operations may be performed on the query instance.
     * 
     * @param criteriaBuilder
     *            the {@link CriteriaBuilder} used to build the query
     * @param query
     *            the {@link CriteriaQuery} being built
     */
    public void queryHasBeenBuilt(CriteriaBuilder criteriaBuilder,
            CriteriaQuery<?> query);

    /**
     * This method is called after filters (in the form of {@link Filter}) have
     * been translated into instances of {@link Predicate}, but before the
     * resulting predicates have been added to <code>query</code>.
     * 
     * The contents of the <code>predicates</code> list may be modified at this
     * point. Any operations may be performed on the query instance.
     * 
     * @param criteriaBuilder
     *            the {@link CriteriaBuilder} used to build the query
     * @param query
     *            the {@link CriteriaQuery} being built
     * @param predicates
     *            the list of predicates ({@link Predicate}) to be applied. The
     *            contents of this list may be modified.
     */
    public void filtersWillBeAdded(CriteriaBuilder criteriaBuilder,
            CriteriaQuery<?> query, List<Predicate> predicates);

    /**
     * This method is called after all filters have been applied to the query.
     * 
     * Any operations may be performed on the query instance.
     * 
     * @param criteriaBuilder
     *            the {@link CriteriaBuilder} used to build the query
     * @param query
     *            the {@link CriteriaQuery} being built
     */
    public void filtersWereAdded(CriteriaBuilder criteriaBuilder,
            CriteriaQuery<?> query);

    /**
     * This method is called after all {@link SortBy} instances have been
     * translated into {@link Order} instances, but before they have been
     * applied to the query.
     * 
     * The contents of the <code>orderBy</code> list may be modified at this
     * point. Any operations may be performed on the query instance.
     * 
     * @param criteriaBuilder
     *            the {@link CriteriaBuilder} used to build the query
     * @param query
     *            the {@link CriteriaQuery} being built
     * @param orderBy
     *            the list of order by rules ({@link Order}) to be applied. The
     *            contents of this list may be modified.
     */
    public void orderByWillBeAdded(CriteriaBuilder criteriaBuilder,
            CriteriaQuery<?> query, List<Order> orderBy);

    /**
     * This method is called after the order by has been applied for the query.
     * 
     * Any operations may be performed on the query instance.
     * 
     * @param criteriaBuilder
     *            the {@link CriteriaBuilder} used to build the query
     * @param query
     *            the {@link CriteriaQuery} being built
     */
    public void orderByWasAdded(CriteriaBuilder criteriaBuilder,
            CriteriaQuery<?> query);
}