Package org.alfresco.rest.framework.resource.parameters

Class Paging

java.lang.Object

org.alfresco.rest.framework.resource.parameters.Paging

public class Paging
extends Object

Represents paging of collections of resources. Set by the client request.
skipCount - How many entries exist in the entire collection before those included in the list
maxItems - The maximum number of items the client requires. Defaults to 100.

Author:

Gethin James, Martin Muller (mmuller)

Field Summary

Fields

Modifier and Type	Field	Description
static final Paging	DEFAULT
static final int	DEFAULT_MAX_ITEMS
static final int	DEFAULT_SKIP_COUNT

Method Summary

Modifier and Type	Method	Description
int	getMaxItems()	The maximum number of items the client requires.
String	getSearchAfterToken()	The opaque search_after cursor for the next page, or null if not using cursor-based paging.
int	getSkipCount()	How many entries exist in the entire collection before those included in the list
String	toString()
static Paging	valueOf(int skipCount, int maxItems)
static Paging	valueOf(int skipCount, int maxItems, String searchAfterToken)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SKIP_COUNT

public static final int DEFAULT_SKIP_COUNT

See Also:

• Constant Field Values

DEFAULT_MAX_ITEMS

public static final int DEFAULT_MAX_ITEMS

See Also:

• Constant Field Values

DEFAULT

public static final Paging DEFAULT

Method Details

getSkipCount

public int getSkipCount()

How many entries exist in the entire collection before those included in the list

Returns:

Integer

getMaxItems

public int getMaxItems()

The maximum number of items the client requires. Defaults to 100.

Returns:

Integer

getSearchAfterToken

public String getSearchAfterToken()

The opaque search_after cursor for the next page, or null if not using cursor-based paging.

Returns:

String

valueOf

public static Paging valueOf(int skipCount,
 int maxItems)

valueOf

public static Paging valueOf(int skipCount,
 int maxItems,
 String searchAfterToken)

toString

public String toString()

Overrides:

toString in class Object