com.adobe.cq.social.scf

Class PageInfo

java.lang.Object

com.adobe.cq.social.scf.PageInfo

Direct Known Subclasses:

PageInfo

public class PageInfo
extends java.lang.Object

Shows information about the collection's pages.

Constructor Summary

Constructors

Constructor and Description
PageInfo(SocialCollectionComponent component, ClientUtilities clientUtils, CollectionPagination pagination)
PageInfo(SocialCollectionComponent component, ClientUtilities clientUtils, CollectionPagination pagination, java.lang.String params)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBasePageURL() Returns the base page URL based on the current social component.
long	getCurrentIndex() The current offset into the index that is being used for the pages.
java.lang.String	getIncludedPath()
java.lang.String	getNextPageURL() A simple function for getting the next page in the results.
java.lang.String	getNextSuffix()
long	getPageSize() Gets the current configuration for the size of a page.
java.lang.String	getPreviousPageURL() A simple function for getting the next page in the results.
java.lang.String	getPreviousSuffix()
java.lang.String	getSelectedIndex() The current offset into the index that is being used for the pages.
long	getSelectedPage() Gets the current page number.
long	getTotalPages() Gets the total number of pages in this component.
java.lang.String	getURLPattern() Gets the url pattern for fetching other pages with two tokens ${startIndex} and ${size} which determine where to start the next page from and how many entries to fetch.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageInfo

public PageInfo(SocialCollectionComponent component,
                ClientUtilities clientUtils,
                CollectionPagination pagination)

PageInfo

public PageInfo(SocialCollectionComponent component,
                ClientUtilities clientUtils,
                CollectionPagination pagination,
                java.lang.String params)

Method Detail

getURLPattern

public java.lang.String getURLPattern()

Gets the url pattern for fetching other pages with two tokens ${startIndex} and ${size} which determine where to start the next page from and how many entries to fetch.

Returns:

a string with the format http://host:port/pathtocomponent.${startIndex}.${size}.selectors.format

getSelectedPage

public long getSelectedPage()

Gets the current page number.

Returns:

the current page number

getTotalPages

public long getTotalPages()

Gets the total number of pages in this component.

Returns:

the total number of pages

getPageSize

public long getPageSize()

Gets the current configuration for the size of a page.

Returns:

the size of a page in items

getCurrentIndex

public long getCurrentIndex()

The current offset into the index that is being used for the pages.

Returns:

the current index

getNextPageURL

public java.lang.String getNextPageURL()

A simple function for getting the next page in the results. If it is the last page it points to this page.

Returns:

a url for the next page

getPreviousPageURL

public java.lang.String getPreviousPageURL()

A simple function for getting the next page in the results.

Returns:

a url for the previous page

getNextSuffix

public java.lang.String getNextSuffix()

getPreviousSuffix

public java.lang.String getPreviousSuffix()

getSelectedIndex

public java.lang.String getSelectedIndex()

The current offset into the index that is being used for the pages.

Returns:

the current index

getBasePageURL

public java.lang.String getBasePageURL()

Returns the base page URL based on the current social component.

Returns:

a string that points to the path to the page that contains the component.

getIncludedPath

public java.lang.String getIncludedPath()