net.guerlab.spring.searchparams.AbstractSearchParams Maven / Gradle / Ivy

Go to download
package net.guerlab.spring.searchparams;

import javax.persistence.Transient;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
 * 抽象通用搜索参数对象
 *
 * @author guer
 *
 */
@ApiModel(value = "抽象通用搜索参数对象")
public abstract class AbstractSearchParams {

    /**
     * 分页ID
     */
    @ApiModelProperty(value = "分页ID", example = "1", allowableValues = "range[1, infinity]")
    @Transient
    protected int pageId = 1;

    /**
     * 分页内容数量
     */
    @ApiModelProperty(value = "分页内容数量", example = "10", allowableValues = "range[1, infinity]")
    @Transient
    protected int pageSize = 10;

    /**
     * 获取分页ID
     *
     * @return 分页ID
     */
    public final int getPageId() {
        return pageId;
    }

    /**
     * 设置分页ID
     *
     * @param pageId
     *            分页ID
     */
    public final void setPageId(
            final int pageId) {
        this.pageId = pageId;
    }

    /**
     * 获取分页内容数量
     *
     * @return 分页内容数量
     */
    public final int getPageSize() {
        return pageSize;
    }

    /**
     * 设置分页内容数量
     *
     * @param pageSize
     *            分页内容数量
     */
    public final void setPageSize(
            final int pageSize) {
        this.pageSize = pageSize;
    }
}