net.dona.doip.client.QueryParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doip-sdk Show documentation

DOIP Software Development Kit that implements DOIP v2 Specification.

There is a newer version: 2.2.0

package net.dona.doip.client;

import java.util.Collections;
import java.util.List;

/**
 * An object for holding query parameters for {@link DoipClient} search operations.
 */
public class QueryParams {

    /**
     * Default query parameters.  Passing {@code null} to search methods amounts to using this.  No pagination and no sorting.
     */
    public static final QueryParams DEFAULT = new QueryParams(0, -1);

    private final List sortFields;
    private final int pageNumber;
    private final int pageSize;

    /**
     * Constructs a QueryParams.
     * @param pageNumber the page number to return.  Starts at 0.  Ignored if pageSize <= 0.
     * @param pageSize the number of objects to return.  PageSize of < 0 means return all.
     */
    public QueryParams(int pageNumber, int pageSize) {
        this(pageNumber, pageSize, Collections.emptyList());
    }

    /**
     * Constructs a QueryParams.
     * @param pageNumber the page number to return.  Starts at 0.  Ignored if pageSize <= 0.
     * @param pageSize the number of objects to return.  PageSize of < 0 means return all.
     * @param sortFields the sort order
     */
    public QueryParams(int pageNumber, int pageSize, List sortFields) {
        this.pageNumber = pageNumber;
        this.pageSize = pageSize;
        this.sortFields = sortFields;
    }

    public int getPageNumber() {
        return pageNumber;
    }

    public int getPageSize() {
        return pageSize;
    }

    public List getSortFields() {
        return sortFields;
    }
}