com.novell.nds.dirxml.driver.rest.pagination

Interface Paginator

public interface Paginator

Interface for Paginator.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFirstPageUrl()
java.lang.String	getNextPageUrl(java.lang.String response, java.util.HashMap<java.lang.String,java.lang.String> responseHeaders)
void	init(java.lang.String resourceUrl, java.util.HashMap<java.lang.String,java.lang.String> paginationParm)

Method Detail

init

void init(java.lang.String resourceUrl,
          java.util.HashMap<java.lang.String,java.lang.String> paginationParm)
   throws com.novell.nds.dirxml.driver.rest.pagination.PaginationException

Parameters:

resourceUrl - Original url for the resource to be polled.

paginationParm - hashMap with pagination params.

Throws:

com.novell.nds.dirxml.driver.rest.pagination.PaginationException - Pagination exception.

getNextPageUrl

java.lang.String getNextPageUrl(java.lang.String response,
                                java.util.HashMap<java.lang.String,java.lang.String> responseHeaders)
                         throws com.novell.nds.dirxml.driver.rest.pagination.PaginationException

Parameters:

response - Http Response from the endpoint.

responseHeaders - http Headers from the endpoint.

Returns:

return next page url.

Throws:

com.novell.nds.dirxml.driver.rest.pagination.PaginationException - Pagination exception.

getFirstPageUrl

java.lang.String getFirstPageUrl()
                          throws com.novell.nds.dirxml.driver.rest.pagination.PaginationException

Returns:

return first Page url.

Throws:

com.novell.nds.dirxml.driver.rest.pagination.PaginationException - Pagination exception.