@eclipse-scout/core/dist/d.ts/src/table/TableMaxResultsHelper.d.ts

Eclipse Scout runtime

import { BaseDoEntity, DoEntity, Table, TableReloadReason } from '../index';
export declare class TableMaxResultsHelper {
    /**
     * Checks if more data could be loaded into the table.
     * @param numRows The number of currently loaded rows of the table.
     * @param estRows The number of estimated rows that would be available.
     * @param maxRows The number of maximum rows that are allowed to be loaded.
     * @returns true if a estRows and maxRows are available and the currently loaded number of rows (numRows) is smaller than the two. This means more data could be loaded.
     */
    isLoadMoreDataPossible(numRows: number, estRows: number, maxRows: number): boolean;
    /**
     * Adds a DataObject contribution of type {@link MaxRowCountContributionDo} to the given dataObject if necessary, removes an existing contribution otherwise.
     * @param dataObject The DataObject to which the contribution should be added.
     * @param table The table for which the {@link MaxRowCountContributionDo} should be added.
     * @param reloadReason The reason of the reload for which the {@link MaxRowCountContributionDo} should be added.
     */
    withMaxRowCountContribution<T extends {
        _contributions?: DoEntity[];
    }>(dataObject: T, table: Table, reloadReason?: TableReloadReason): T;
    /**
     * Reads the maximum number of rows for the given table and reason and converts it to a {@link MaxRowCountContributionDo}.
     * @param table The table for which the {@link MaxRowCountContributionDo} should be returned.
     * @param reloadReason The reason of the reload for which the {@link MaxRowCountContributionDo} should be added.
     * @returns the {@link MaxRowCountContributionDo} if there is a valid maxRowCount for the given table or null if no row count constraint is used.
     */
    buildMaxRowCountContribution(table: Table, reloadReason: TableReloadReason): MaxRowCountContributionDo;
    /**
     * @param table The table for which the max table row count should be returned.
     * @param reloadReason The reason of the reload for which the max table row count should be returned.
     * @returns the maximum number of rows for the given table and reload reason.
     */
    getMaxTableRowCount(table: Table, reloadReason: TableReloadReason): number;
}
export declare class MaxRowCountContributionDo extends BaseDoEntity {
    override: number;
    hint: number;
}
export interface LimitedResultInfoContributionDo extends DoEntity {
    limitedResult: boolean;
    maxRowCount?: number;
    estimatedRowCount?: number;
}
//# sourceMappingURL=TableMaxResultsHelper.d.ts.map