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
PaginationParameters(java.lang.String paginationType, java.lang.String lastKey, java.lang.Integer maxItems)	Constructor with token-based pagination parameters

Method Summary

Modifier and Type	Method	Description
java.lang.String	getLastKey()	Gets the lastKey
java.lang.Integer	getMaxItems()	Gets the maxItems
java.lang.Integer	getPage()	Gets the page
java.lang.Integer	getPageSize()	Gets the page size
java.lang.String	getPaginationType()	Gets the pagination type
boolean	isIncludeAll()	Gets includeAll
PaginationParameters	setIncludeAll(boolean includeAll)	Sets includeAll
PaginationParameters	setLastKey(java.lang.String lastKey)	Sets the lastKey
PaginationParameters	setMaxItems(java.lang.Integer maxItems)	Sets the maxItems
PaginationParameters	setPage(java.lang.Integer page)	Sets the page
PaginationParameters	setPageSize(java.lang.Integer pageSize)	Sets the page size
PaginationParameters	setPaginationType(java.lang.String paginationType)	Sets the pagination type
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

PaginationParameters

public PaginationParameters(java.lang.String paginationType,
                            java.lang.String lastKey,
                            java.lang.Integer maxItems)

Constructor with token-based pagination parameters

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

getPaginationType

public java.lang.String getPaginationType()

Gets the pagination type

Returns:

pagination type

setPaginationType

public PaginationParameters setPaginationType(java.lang.String paginationType)

Sets the pagination type

Parameters:

paginationType - the pagination type (e.g. "token")

getLastKey

public java.lang.String getLastKey()

Gets the lastKey

Returns:

lastKey for token-based pagination

setLastKey

public PaginationParameters setLastKey(java.lang.String lastKey)

Sets the lastKey

Parameters:

lastKey - the lastKey for token-based pagination

getMaxItems

public java.lang.Integer getMaxItems()

Gets the maxItems

Returns:

maxItems for token-based pagination

setMaxItems

public PaginationParameters setMaxItems(java.lang.Integer maxItems)

Sets the maxItems

Parameters:

maxItems - the maxItems for token-based pagination

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