org.springframework.data.rest.webmvc.support

Interface PagingAndSortingTemplateVariables

All Superinterfaces:

org.springframework.hateoas.mvc.UriComponentsContributor

public interface PagingAndSortingTemplateVariables
extends org.springframework.hateoas.mvc.UriComponentsContributor

Interface to abstract the access of TemplateVariables for pagination and sorting.

Since:

2.3

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
org.springframework.hateoas.TemplateVariables	getPaginationTemplateVariables(org.springframework.core.MethodParameter parameter, org.springframework.web.util.UriComponents components) Returns the TemplateVariables for pagination.
org.springframework.hateoas.TemplateVariables	getSortTemplateVariables(org.springframework.core.MethodParameter parameter, org.springframework.web.util.UriComponents components) Returns the TemplateVariables for sorting.

Methods inherited from interface org.springframework.hateoas.mvc.UriComponentsContributor

enhance, supportsParameter

Method Detail

getPaginationTemplateVariables

org.springframework.hateoas.TemplateVariables getPaginationTemplateVariables(org.springframework.core.MethodParameter parameter,
                                                                             org.springframework.web.util.UriComponents components)

Returns the TemplateVariables for pagination.

Parameters:

parameter - can be null.

components - must not be null.

Returns:

getSortTemplateVariables

org.springframework.hateoas.TemplateVariables getSortTemplateVariables(org.springframework.core.MethodParameter parameter,
                                                                       org.springframework.web.util.UriComponents components)

Returns the TemplateVariables for sorting.

Parameters:

parameter - can be null.

components - must not be null.

Returns: