Interface PaginatableHypermediaConverter
-
- All Superinterfaces:
HypermediaConverter
@ProviderType public interface PaginatableHypermediaConverter extends HypermediaConverter
Interface for a hypermedia converter that can render a Resource with paginated entities into a particular hypermedia type.
-
-
Field Summary
-
Fields inherited from interface com.adobe.granite.haf.converter.api.HypermediaConverter
MEDIA_TYPE_ADOBE_ASSETS, MEDIA_TYPE_ADOBE_DIRECTORY, MEDIA_TYPE_ADOBE_METADATA, MEDIA_TYPE_ADOBE_RENDITION, MEDIA_TYPE_ADOBE_VERSIONS, MEDIA_TYPE_SIREN
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<OrderByDetails>
getOrderBy(HttpServletRequest request)
Get the order by details from the request.int
getPaginationLimitValue(HttpServletRequest request)
Gets the pagination limit value from the request.java.lang.String
getPaginationStartValue(HttpServletRequest request)
Gets the pagination start value from the request.-
Methods inherited from interface com.adobe.granite.haf.converter.api.HypermediaConverter
getMediaTypeMatcher, render, renderSubEntity
-
-
-
-
Method Detail
-
getPaginationStartValue
@CheckForNull java.lang.String getPaginationStartValue(HttpServletRequest request)
Gets the pagination start value from the request. This can then be injected into methods to allow them to correctly respond to paginated requests.- Parameters:
request
- current HTTP request- Returns:
- a string is the value of the pagination startparameter
-
getPaginationLimitValue
int getPaginationLimitValue(HttpServletRequest request)
Gets the pagination limit value from the request. This can then be injected into methods to allow them to correctly respond to paginated requests.- Parameters:
request
- current HTTP request- Returns:
- a string is the value of the pagination limit parameter or -1 if the limit is not specified
-
getOrderBy
@Nonnull java.util.List<OrderByDetails> getOrderBy(HttpServletRequest request)
Get the order by details from the request. This can then be injected into methods to allow them to correctly. respond.- Parameters:
request
- current HTTP request.- Returns:
- A List of OrderByDetails.
-
-