// Generated by xsd compiler for android/java
// DO NOT CHANGE!
package com.ebay.marketplace.search.v1.services;
import java.io.Serializable;
import com.leansoft.nano.annotation.*;
/**
*
* Controls the pagination of the result set. Child elements specify the maximum
* number of item listings to return per call and which page of data to return.
* Controls which listings are returned in the response, but does not control
* the details associated with the returned items.
*
*/
public class PaginationInput implements Serializable {
private static final long serialVersionUID = -1L;
@Element
private Integer pageNumber;
@Element
private Integer entriesPerPage;
@Element
private String delimiter;
/**
* public getter
*
*
* Specifies which subset of data (or "page") to return in the call
* response. The number of data pages is determined by the total number of
* items matching the request search criteria (returned in
* paginationOutput.totalEntries) divided by the number of entries to
* display in each response (entriesPerPage). You can return up to the first
* 100 pages of the result set by issuing multiple requests and specifying,
* in sequence, the pages to return.
*
*
* @returns java.lang.Integer
*/
public Integer getPageNumber() {
return this.pageNumber;
}
/**
* public setter
*
*
* Specifies which subset of data (or "page") to return in the call
* response. The number of data pages is determined by the total number of
* items matching the request search criteria (returned in
* paginationOutput.totalEntries) divided by the number of entries to
* display in each response (entriesPerPage). You can return up to the first
* 100 pages of the result set by issuing multiple requests and specifying,
* in sequence, the pages to return.
*
*
* @param java.lang.Integer
*/
public void setPageNumber(Integer pageNumber) {
this.pageNumber = pageNumber;
}
/**
* public getter
*
*
* Specifies the maximum number of entries to return in a single call. If
* the number of entries found on the specified pageNumber is less than the
* value specified here, the number of items returned will be less than the
* value of entriesPerPage. This indicates the end of the result set.
* <br><br>
* If entriesPerPage is set to a number greater than 100, the default value,
* 100, will be used.
*
*
* @returns java.lang.Integer
*/
public Integer getEntriesPerPage() {
return this.entriesPerPage;
}
/**
* public setter
*
*
* Specifies the maximum number of entries to return in a single call. If
* the number of entries found on the specified pageNumber is less than the
* value specified here, the number of items returned will be less than the
* value of entriesPerPage. This indicates the end of the result set.
* <br><br>
* If entriesPerPage is set to a number greater than 100, the default value,
* 100, will be used.
*
*
* @param java.lang.Integer
*/
public void setEntriesPerPage(Integer entriesPerPage) {
this.entriesPerPage = entriesPerPage;
}
/**
* public getter
*
* @returns java.lang.String
*/
public String getDelimiter() {
return this.delimiter;
}
/**
* public setter
*
* @param java.lang.String
*/
public void setDelimiter(String delimiter) {
this.delimiter = delimiter;
}
}