Pipelet: Common Paging

Pipelet Paging

This pipelet creates a PagingModel for paging through lists of Objects. The pipelet accepts a Collection or Iterator as the list of Objects. If an Iterator is used, then ObjectsCount must also be provided.

Start determines the first item in the search set to return and PageSize determines the total number of items to return. The first item in the search set is indicated with zero, not one.

For example, if you specify a Start of 0 and a Page Size of 15, then items 1-15 are returned. If you specify a Start of 15 and a PageSize of 15, then items 16-30 are returned.

Start and PageSize are optional parameters. If no Start value is provided, then zero is used as the Start value. If no PageSize is provided, then the pipelet uses the configured DefaultPageSize. If no DefaultPageSize exists, then a page size of 10 is used.



Configuration Properties

DefaultPageSize : Integer Optional

Used if no PageSize input value is provided. If no DefaultPageSize is specified, pipelet uses 10 as the page size.

Input Parameters

Objects : Object Required

dw.util.Collection or dw.util.Iterator of objects.

PageSize : Number Optional

Number of search items to return. If not provided, the DefaultPageSize value is used instead.

Start : Number Optional

The first item requested in the subset of the search. For example, assume the default PageSize is set to 12. To return the first page: Start is 0, for the second page: Start is 12, for the third page: Start is 24. Usually, this is specified using logic that determines the total number of items in the search set and makes sure that the Start parameter is not higher than the total number of items in the search set and is a multiple of the PageSize. If not provided, a Start of 0 is used.

ObjectsCount : Number Optional

Output Parameters

PagingModel : PagingModel : Optional