org.dbflute.bhv.referrer.ReferrerConditionSetupper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation

The runtime library of DBFlute

There is a newer version: 1.2.8

/*
 * Copyright 2014-2019 the original author or authors.
 *
 * 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.dbflute.bhv.referrer;

import org.dbflute.cbean.ConditionBean;

/**
 * The set-upper of condition-bean for referrer.
 *  * loader.loadPurchaseList(memberList, referrerCB -> {
 *     cb.setupSelect_Product();
 *     cb.query().setPurchasePrice_GreaterEqual(2000);
 *     cb.query().addOrderBy_PurchaseDatetime_Desc();
 *     ...
 * }); // you can also load nested referrer from here
 * //}).withNestedList(purchaseLoader -> {
 * //    purchaseLoader.loadPurchasePaymentList(...);
 * //});
 * for (Member member : memberList) {
 *     List<Purchase> purchaseList = member.getPurchaseList();
 *     for (Purchase purchase : purchaseList) {
 *         ...
 *     }
 * }
 * 
 * @param  The type of condition-bean for referrer.
 * @author jflute
 * @since 1.0.5F (2014/05/12 Monday)
 */
@FunctionalInterface
public interface ReferrerConditionSetupper {

    /**
     * Set up condition-bean for referrer. 

     * You can call SetupSelect, Query, OrderBy... 

     * Ordering by FK is already set up so you should add next order condition here.
     *      * loader.loadPurchaseList(memberList, referrerCB -> {
     *     cb.setupSelect_Product();
     *     cb.query().setPurchasePrice_GreaterEqual(2000);
     *     cb.query().addOrderBy_PurchaseDatetime_Desc();
     *     ...
     * }); // you can also load nested referrer from here
     * //}).withNestedList(purchaseLoader -> {
     * //    purchaseLoader.loadPurchasePaymentList(...);
     * //});
     * for (Member member : memberList) {
     *     List<Purchase> purchaseList = member.getPurchaseList();
     *     for (Purchase purchase : purchaseList) {
     *         ...
     *     }
     * }
     * 
     * @param refCB The prepared instance of condition-bean for referrer table. (NotNull)
     */
    void setup(CB refCB);
}