Package com.helixframework.api.contract

Class OffsetPaginatedResponse<T>

java.lang.Object

com.helixframework.api.contract.OffsetPaginatedResponse<T>

Type Parameters:

T - item type

public class OffsetPaginatedResponse<T>
extends Object

API response that returns a collection with offset pagination.

Constructor Summary

Constructors

Constructor	Description
OffsetPaginatedResponse()	Creates an instance of OffsetPaginatedResponse.
OffsetPaginatedResponse(long offset, long limit, Collection<T> items)	Creates an instance of OffsetPaginatedResponse.

Method Summary

Modifier and Type	Method	Description
int	getCount()	Gets the number of items in the collection.
List<T>	getItems()	Gets the items.
Long	getLimit()	Gets the page limit.
Long	getOffset()	Gets the pagination offset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OffsetPaginatedResponse

public OffsetPaginatedResponse()

Creates an instance of OffsetPaginatedResponse.

OffsetPaginatedResponse

public OffsetPaginatedResponse(long offset,
 long limit,
 Collection<T> items)

Creates an instance of OffsetPaginatedResponse.

Parameters:

offset - page offset

limit - page limit

items - items to return in response

Method Details

getCount

public int getCount()

Gets the number of items in the collection.

Returns:

number of items in the collection

getOffset

public Long getOffset()

Gets the pagination offset. The total number of records to offset before beginning to return results.

Returns:

pagination offset

getLimit

public Long getLimit()

Gets the page limit. The total number of results to return.

Returns:

page limit

getItems

public List<T> getItems()

Gets the items.

Returns:

items