com.gooddata.collections

Interface Page

All Known Implementing Classes:

PageRequest

public interface Page

Defines logic for generating page URIs.

Method Summary

Modifier and Type	Method and Description
URI	getPageUri(org.springframework.web.util.UriComponentsBuilder uriBuilder) Creates URI for this page request.
org.springframework.web.util.UriComponentsBuilder	updateWithPageParams(org.springframework.web.util.UriComponentsBuilder uriBuilder) Updates provided URI builder query params according to this page configuration.

Method Detail

getPageUri

URI getPageUri(org.springframework.web.util.UriComponentsBuilder uriBuilder)

Creates URI for this page request.

Use updateWithPageParams(UriComponentsBuilder) if you have URI template and only want to update it with page query params.

Parameters:

uriBuilder - URI builder used for generating page URI

Returns:

compiled page URI

updateWithPageParams

org.springframework.web.util.UriComponentsBuilder updateWithPageParams(org.springframework.web.util.UriComponentsBuilder uriBuilder)

Updates provided URI builder query params according to this page configuration.

As getPageUri(UriComponentsBuilder) returns expanded page URI it is not very useful for cases that require use of URI template with URI variables. This method allows you to use URI templates and benefit from pagination support implemented in Page implementations. It is especially useful if you need to handle multiple requests of the same URI template in the same way - e.g. monitor request made by RestOperations methods.

Use this in the situation when you have URI template with placeholders and URI variables separately. This method is useful when you have URI template with placeholders and only want to add query parameters based on this page to it.

Use getPageUri(UriComponentsBuilder) if you want to get concrete page URI and don't have URI template.

Parameters:

uriBuilder - URI builder used for constructing page URI

Returns:

provided and updated builder instance

See Also:

RestOperations