Package com.smartsheet.api.models

Class PaginationParameters

java.lang.Object

com.smartsheet.api.models.PaginationParameters

public class PaginationParameters
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaginationParameters.PaginationParametersBuilder	A convenience class for creating a PaginationParameters object

Constructor Summary

Constructors

Constructor	Description
PaginationParameters()
PaginationParameters(boolean includeAll, java.lang.Integer pageSize, java.lang.Integer page)	Constructor

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getPage()	Gets the page
java.lang.Integer	getPageSize()	Gets the page size
boolean	isIncludeAll()	Gets includeAll
PaginationParameters	setIncludeAll(boolean includeAll)	Sets includeAll
PaginationParameters	setPage(java.lang.Integer page)	Sets the page
PaginationParameters	setPageSize(java.lang.Integer pageSize)	Sets the page size
java.util.Map<java.lang.String,java.lang.Object>	toHashMap()	Convert to a hash map
java.lang.String	toQueryString()	Convert to a query string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaginationParameters

public PaginationParameters()

PaginationParameters

public PaginationParameters(boolean includeAll,
                            java.lang.Integer pageSize,
                            java.lang.Integer page)

Constructor

Method Detail

isIncludeAll

public boolean isIncludeAll()

Gets includeAll

Returns:

includeAll

setIncludeAll

public PaginationParameters setIncludeAll(boolean includeAll)

Sets includeAll

Parameters:

includeAll - include all parameter

getPageSize

public java.lang.Integer getPageSize()

Gets the page size

Returns:

page size

setPageSize

public PaginationParameters setPageSize(java.lang.Integer pageSize)

Sets the page size

Parameters:

pageSize - the page size

getPage

public java.lang.Integer getPage()

Gets the page

Returns:

page the page number

setPage

public PaginationParameters setPage(java.lang.Integer page)

Sets the page

Parameters:

page - the page number

toQueryString

public java.lang.String toQueryString()

Convert to a query string

toHashMap

public java.util.Map<java.lang.String,java.lang.Object> toHashMap()

Convert to a hash map