org.nuiton.topia.persistence.pager.PagerBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
ToPIA API module
The newest version!
package org.nuiton.topia.persistence.pager;

/*-
 * #%L
 * ToPIA Extension :: API
 * %%
 * Copyright (C) 2018 - 2022 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import org.apache.commons.lang3.builder.ToStringBuilder;

import java.io.Serializable;

/**
 * Created on 10/05/2022.
 *
 * @author Tony Chemit - [email protected]
 * @since
 */
public class PagerBean implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * Number of records (says numbers of rows displayable.
     */
    protected long records;

    /**
     * Index of the first record in this page.
     */
    protected long recordStartIndex;

    /**
     * Index of the last record in this page.
     */
    protected long recordEndIndex;

    /**
     * Index of the page.
     */
    protected int pageIndex;

    /**
     * Page size, says number of records in a page.
     */
    protected int pageSize;

    /**
     * Number of pages.
     */
    protected long pagesNumber;

    public long getRecords() {
        return records;
    }

    public long getRecordStartIndex() {
        return recordStartIndex;
    }

    public long getRecordEndIndex() {
        return recordEndIndex;
    }

    public int getPageIndex() {
        return pageIndex;
    }

    public int getPageSize() {
        return pageSize;
    }

    public long getPagesNumber() {
        return pagesNumber;
    }

    public void setRecords(long records) {
        this.records = records;
    }

    public void setRecordStartIndex(long recordStartIndex) {
        this.recordStartIndex = recordStartIndex;
    }

    public void setRecordEndIndex(long recordEndIndex) {
        this.recordEndIndex = recordEndIndex;
    }

    public void setPageIndex(int pageIndex) {
        this.pageIndex = pageIndex;
    }

    public void setPageSize(int pageSize) {
        this.pageSize = pageSize;
    }

    public void setPagesNumber(long pagesNumber) {
        this.pagesNumber = pagesNumber;
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this)
                .append("records", records)
                .append("recordStartIndex", recordStartIndex)
                .append("recordEndIndex", recordEndIndex)
                .append("pageIndex", pageIndex)
                .append("pageSize", pageSize)
                .append("pagesNumber", pagesNumber)
                .toString();
    }

}