org.dbflute.cbean.chelper.HpColumnSpHandler Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014-2020 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.cbean.chelper;

import org.dbflute.cbean.dream.SpecifiedColumn;
import org.dbflute.dbmeta.DBMeta;

/**
 * @author jflute
 */
public interface HpColumnSpHandler {

    // ===================================================================================
    //                                                                              DBMeta
    //                                                                              ======
    DBMeta asDBMeta();

    // ===================================================================================
    //                                                                Column Specification
    //                                                                ====================
    SpecifiedColumn xspecifyColumn(String columnName); // internal

    boolean hasSpecifiedColumn();

    boolean isSpecifiedColumn(String columnName);

    // ===================================================================================
    //                                                                        Theme Column
    //                                                                        ============
    /**
     * Specify every column in the table. 

     * You cannot use normal SpecifyColumn with this method.
     * no check of modified properties in entities when BatchUpdate.
     */
    void everyColumn();

    boolean isSpecifiedEveryColumn();

    /**
     * Specify columns except record meta columns. e.g. commonColumn, versionNo 

     * You cannot use normal SpecifyColumn with this method. 

     * Basically you don't need this when BatchUpdate
     * because record meta columns are automatically controlled.
     */
    void exceptRecordMetaColumn();

    boolean isSpecifiedExceptColumn();

    // ===================================================================================
    //                                                              Synchronization QyCall
    //                                                              ======================
    boolean xhasSyncQyCall();
}