org.dbflute.bhv.referrer.ReferrerListHandler 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-2023 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 java.util.List;

import org.dbflute.Entity;

/**
 * The handler of referrer list to load nested referrer.
 *  * MemberCB cb = new MemberCB();
 * cb.query().set...
 * List<Member> statusList = memberBhv.selectList(cb);
 * memberBhv.loadPurchaseList(statusList, new ReferrerConditionSetupper<PurchaseCB>() {
 *     public void setup(PurchaseCB cb) {
 *         cb.query().set...
 *         cb.query().addOrderBy_PurchasePrice_Desc();
 *     }
 * }).withNestedReferrer(new ReferrerListHandler<Purchase>() {
 *     public void handle(List<Purchase> referrerList) {
 *         // you can call LoadReferrer here for nested referrer as you like it
 *         memberBhv.loadPurchasePaymentList(referrerList, new ReferrerConditionSetupper<PurchasePaymentCB>() {
 *             public void setup(PurchasePaymentCB cb) {
 *                 cb.query().set...
 *                 cb.query().addOrderBy_PaymentAmount_Desc();
 *             }
 *         });
 *         ...
 *     }
 * }
 * 
 * @param  The type of referrer entity.
 * @author jflute
 */
@FunctionalInterface
public interface ReferrerListHandler {

    /**
     * Handle the list of referrer to load nested referrer. 

     * You can call LoadReferrer for nested table.
     *      * MemberCB cb = new MemberCB();
     * cb.query().set...
     * List<Member> statusList = memberBhv.selectList(cb);
     * memberBhv.loadPurchaseList(statusList, new ReferrerConditionSetupper<PurchaseCB>() {
     *     public void setup(PurchaseCB cb) {
     *         cb.query().set...
     *         cb.query().addOrderBy_PurchasePrice_Desc();
     *     }
     * }).withNestedReferrer(new ReferrerListHandler<Purchase>() {
     *     public void handle(List<Purchase> referrerList) {
     *         // you can call LoadReferrer here for nested referrer as you like it
     *         memberBhv.loadPurchasePaymentList(referrerList, new ReferrerConditionSetupper<PurchasePaymentCB>() {
     *             public void setup(PurchasePaymentCB cb) {
     *                 cb.query().set...
     *                 cb.query().addOrderBy_PaymentAmount_Desc();
     *             }
     *         });
     *         ...
     *     }
     * }
     * 
     * @param referrerList The entity list of referrer. (NotNull: might be empty)
     */
    void handle(List referrerList);
}