Package com.broadleafcommerce.metadata.dsl.core.extension.endpoints

Interface PageableEndpoint<E extends PageableEndpoint<E>>

All Superinterfaces:

Copyable<E>, Endpoint<E>, Serializable

All Known Implementing Classes:

DefaultPageableEndpoint

public interface PageableEndpoint<E extends PageableEndpoint<E>>
extends Endpoint<E>

Represents the metadata for a pageable endpoint.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PageableEndpoint.Narrowed
static final class	PageableEndpoint.Numbered	The default page size when paginating a collection.

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Endpoint

Endpoint.Method

Method Summary

Modifier and Type	Method	Description
default boolean	isNarrowedPaging()	Returns whether the endpoint is configured for narrowed paging.
default boolean	isNumberedPaging()	Returns whether the endpoint is configured for numbered paging.
default E	narrowedPaging()	Configures narrowedPaging(int) with a page size of PageableEndpoint.Narrowed.Defaults.PAGE_SIZE.
default E	narrowedPaging(int pageSize)	Configure the endpoint to use parameters for paging a narrowed page.
default E	numberedPaging()	Configures numberedPaging(int) with a page size of PageableEndpoint.Numbered.Defaults.PAGE_SIZE.
default E	numberedPaging(int pageSize)	Configures the endpoint to use parameters for paging a numbered page.
default E	unpaged()	Configure the endpoint to not have any pagination parameters.

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Endpoint

clearHeaders, clearParamMappings, clearParams, delete, get, getHeaders, getMapParams, getMethod, getParams, getParent, getScope, getTransformRequestBody, getTransformResponseBody, getType, getUri, header, headers, mapParam, mapParams, method, method, param, params, patch, post, put, removeHeader, removeMapParam, removeParam, scope, scopes, self, setHeaders, setMapParams, setMethod, setParams, setParent, setScope, setTransformRequestBody, setTransformResponseBody, setType, setUri, transformRequest, transformRequest, transformResponse, transformResponse, type, uri

Method Details

unpaged

default E unpaged()

Configure the endpoint to not have any pagination parameters. This is usually the default state, and is useful when changing a previously paged endpoint into an unpaged one.

Returns:

this

narrowedPaging

default E narrowedPaging(int pageSize)

Configure the endpoint to use parameters for paging a narrowed page. This would result in a forward, an offset, and a page size parameter, for example:

 /products?forward=true&offset=0size=50
 

Parameters:

pageSize - the page size

Returns:

this

narrowedPaging

default E narrowedPaging()

Configures narrowedPaging(int) with a page size of PageableEndpoint.Narrowed.Defaults.PAGE_SIZE.

Returns:

this

isNarrowedPaging

default boolean isNarrowedPaging()

Returns whether the endpoint is configured for narrowed paging.

Returns:

whether or not narrowed paging

numberedPaging

default E numberedPaging(int pageSize)

Configures the endpoint to use parameters for paging a numbered page. This would result in a page number and page size parameter, for example:

 /products?page=1&size=50
 

Parameters:

pageSize - the page size

Returns:

this

numberedPaging

default E numberedPaging()

Configures numberedPaging(int) with a page size of PageableEndpoint.Numbered.Defaults.PAGE_SIZE.

Returns:

this

isNumberedPaging

default boolean isNumberedPaging()

Returns whether the endpoint is configured for numbered paging.

Returns:

whether or not numbered paging