org.springframework.social.alfresco.api.entities
Class Pagination

java.lang.Object
  org.springframework.social.alfresco.api.entities.Pagination

public class Pagination
extends Object

Object describing a collection of entries

Author:

jottley

Field Summary

static String	COUNT Pagination query parameter constant
static String	HASMOREITEMS Pagination query parameter constant
static String	MAXITEMS Pagination query parameter constant
static String	SKIPCOUNT Pagination query parameter constant
static String	TOTALITEMS Pagination query parameter constant

Constructor Summary

Pagination()

Method Summary

long	getCount()
long	getMaxItems()
long	getSkipCount()
long	getTotalItems()
boolean	isHasMoreItems()
void	setCount(int count) Set the number of objects in the entries array.
void	setHasMoreItems(boolean hasMoreItems) Set true if there are more entities in the collection beyond those in this response.
void	setMaxItems(long maxItems) Set the maxItems parameter used to generate this list, or if there was no maxItems parameter the default value, 10.
void	setSkipCount(long skipCount) Set integer describing how many entities exist in the collection before those included in this list.
void	setTotalItems(long totalItems) Set integer describing the total number of entities in the collection.

Methods inherited from class java.lang.Object

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

Field Detail

SKIPCOUNT

public static final String SKIPCOUNT

Pagination query parameter constant

See Also:

Constant Field Values

MAXITEMS

public static final String MAXITEMS

Pagination query parameter constant

See Also:

Constant Field Values

COUNT

public static final String COUNT

Pagination query parameter constant

See Also:

Constant Field Values

HASMOREITEMS

public static final String HASMOREITEMS

Pagination query parameter constant

See Also:

Constant Field Values

TOTALITEMS

public static final String TOTALITEMS

Pagination query parameter constant

See Also:

Constant Field Values

Constructor Detail

Pagination

public Pagination()

Method Detail

getCount

public long getCount()

Returns:

The number of objects in the entries array.

setCount

public void setCount(int count)

Set the number of objects in the entries array.

Parameters:

count -

isHasMoreItems

public boolean isHasMoreItems()

Returns:

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

setHasMoreItems

public void setHasMoreItems(boolean hasMoreItems)

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

Parameters:

hasMoreItems -

getTotalItems

public long getTotalItems()

Returns:

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

setTotalItems

public void setTotalItems(long totalItems)

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

Parameters:

totalItems -

getSkipCount

public long getSkipCount()

Returns:

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

setSkipCount

public void setSkipCount(long skipCount)

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

Parameters:

skipCount -

getMaxItems

public long getMaxItems()

Returns:

The maxItems parameter used to generate this list, or if there was no maxItems parameter the default value, 10.

setMaxItems

public void setMaxItems(long maxItems)

Set the maxItems parameter used to generate this list, or if there was no maxItems parameter the default value, 10.

Parameters:

maxItems -