com.adobe.cq.social.scf

Class CollectionPagination

java.lang.Object

com.adobe.cq.social.scf.CollectionPagination

public class CollectionPagination
extends java.lang.Object

Pagination settings use by the SocialCollectionComponent to determine the number of items on a page and embed levels.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EMBED_LEVEL
static int	DEFAULT_PAGE_SIZE
static CollectionPagination	DEFAULT_PAGINATION
static CollectionPagination	EMBEDDED_LEVEL_PAGINATION
static int	PAGE_SIZE_ALL

Constructor Summary

Constructors

Constructor and Description
CollectionPagination(CollectionPagination copyFrom)
CollectionPagination(int offset) This uses the default embed level and page size.
CollectionPagination(int offset, int size) This uses the default embed level.
CollectionPagination(int offset, int size, int embedLevel)
CollectionPagination(int offset, int size, int embedLevel, java.lang.String sortIndex)
CollectionPagination(int offset, int size, int embedLevel, java.lang.String sortIndex, int pageSizeConfig)

Method Summary

Modifier and Type	Method and Description
int	getEmbedLevel()
int	getOffset()
int	getPageSizeConfig()
int	getSignedSize() Gets the unsigned page size.
int	getSize()
java.lang.String	getSortIndex()

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_SIZE_ALL

public static final int PAGE_SIZE_ALL

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_EMBED_LEVEL

public static final int DEFAULT_EMBED_LEVEL

See Also:

Constant Field Values

DEFAULT_PAGINATION

public static final CollectionPagination DEFAULT_PAGINATION

EMBEDDED_LEVEL_PAGINATION

public static final CollectionPagination EMBEDDED_LEVEL_PAGINATION

Constructor Detail

CollectionPagination

public CollectionPagination(int offset,
                            int size,
                            int embedLevel,
                            java.lang.String sortIndex)

Parameters:

offset - offset from the beginning of the list.

size - number of elements to include.

embedLevel - the level from which items should be embedded as URLs. 0 is the first level.

sortIndex - sorting index

CollectionPagination

public CollectionPagination(int offset,
                            int size,
                            int embedLevel,
                            java.lang.String sortIndex,
                            int pageSizeConfig)

Parameters:

offset - offset from the beginning of the list.

size - number of elements to include.

embedLevel - the level from which items should be embedded as URLs. 0 is the first level.

sortIndex - the index that was requested to be used

pageSizeConfig - the configured size of each page for the component

CollectionPagination

public CollectionPagination(int offset,
                            int size,
                            int embedLevel)

Parameters:

offset - offset from the beginning of the list.

size - number of elements to include.

embedLevel - the level from which items should be embedded as URLs. 0 is the first level.

CollectionPagination

public CollectionPagination(int offset,
                            int size)

This uses the default embed level.

Parameters:

offset - offset from the beginning of the list.

size - number of elements to include.

CollectionPagination

public CollectionPagination(int offset)

This uses the default embed level and page size.

Parameters:

offset - offset from the beginning of the list.

CollectionPagination

public CollectionPagination(CollectionPagination copyFrom)

Method Detail

getOffset

public int getOffset()

getSize

public int getSize()

getSortIndex

public java.lang.String getSortIndex()

getEmbedLevel

public int getEmbedLevel()

getPageSizeConfig

public int getPageSizeConfig()

getSignedSize

public int getSignedSize()

Gets the unsigned page size. Pagination uses negative number to indicate sort direction (Ascending or descending). So 0.-10 will indicate fetch 10 items from 0, but the sort order is reversed

Returns:

the unsigned page size