Package org.alfresco.search.sql.model

Class Pagination

java.lang.Object

org.alfresco.search.sql.model.Pagination

@Validated
public class Pagination
extends Object

Pagination

Constructor Summary

Constructors

Constructor	Description
Pagination()

Method Summary

Modifier and Type	Method	Description
Pagination	count(Long count)
boolean	equals(Object o)
@NotNull Long	getCount()	The number of objects in the entries array.
@NotNull Long	getMaxItems()	The value of the **maxItems** parameter used to generate this list, or if there was no **maxItems** parameter the default value is 100
@NotNull Long	getSkipCount()	An integer describing how many entities exist in the collection before those included in this list.
Long	getTotalItems()	An integer describing the total number of entities in the collection.
int	hashCode()
Pagination	hasMoreItems(Boolean hasMoreItems)
@NotNull Boolean	isHasMoreItems()	A boolean value which is **true** if there are more entities in the collection beyond those in this response.
Pagination	maxItems(Long maxItems)
void	setCount(Long count)
void	setHasMoreItems(Boolean hasMoreItems)
void	setMaxItems(Long maxItems)
void	setSkipCount(Long skipCount)
void	setTotalItems(Long totalItems)
Pagination	skipCount(Long skipCount)
String	toString()
Pagination	totalItems(Long totalItems)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pagination

public Pagination()

Method Detail

count

public Pagination count(Long count)

getCount

@NotNull
public @NotNull Long getCount()

The number of objects in the entries array.

Returns:

count

setCount

public void setCount(Long count)

hasMoreItems

public Pagination hasMoreItems(Boolean hasMoreItems)

isHasMoreItems

@NotNull
public @NotNull Boolean isHasMoreItems()

A boolean value which is **true** if there are more entities in the collection beyond those in this response. A true value means a request with a larger value for the **skipCount** or the **maxItems** parameter will return more entities.

Returns:

hasMoreItems

setHasMoreItems

public void setHasMoreItems(Boolean hasMoreItems)

totalItems

public Pagination totalItems(Long totalItems)

getTotalItems

public Long getTotalItems()

An integer describing the total number of entities in the collection. The API might not be able to determine this value, in which case this property will not be present.

Returns:

totalItems

setTotalItems

public void setTotalItems(Long totalItems)

skipCount

public Pagination skipCount(Long skipCount)

getSkipCount

@NotNull
public @NotNull Long getSkipCount()

An integer describing how many entities exist in the collection before those included in this list.

Returns:

skipCount

setSkipCount

public void setSkipCount(Long skipCount)

maxItems

public Pagination maxItems(Long maxItems)

getMaxItems

@NotNull
public @NotNull Long getMaxItems()

The value of the **maxItems** parameter used to generate this list, or if there was no **maxItems** parameter the default value is 100

Returns:

maxItems

setMaxItems

public void setMaxItems(Long maxItems)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object