Package com.helixframework.api.contract

Class HateoasBidiCursorPaginatedResponse<T>

java.lang.Object

com.helixframework.api.contract.HateoasResponse

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

Type Parameters:

T - item type

public class HateoasBidiCursorPaginatedResponse<T>
extends HateoasResponse

API response that returns a collection with bi-directional cursor pagination and HATEOAS links.

Constructor Summary

Constructors

Constructor	Description
HateoasBidiCursorPaginatedResponse()	Creates a new instance of HateoasBidiCursorPaginatedResponse.
HateoasBidiCursorPaginatedResponse(String nextCursor, String previousCursor, Boolean hasNext, Boolean hasPrevious, Collection<T> items)	Creates a new instance of HateoasBidiCursorPaginatedResponse.
HateoasBidiCursorPaginatedResponse(String nextCursor, String previousCursor, Collection<T> items)	Creates a new instance of HateoasBidiCursorPaginatedResponse.

Method Summary

Modifier and Type	Method	Description
int	getCount()	Gets the number of items in the collection.
List<T>	getItems()	Gets the items.
String	getNextCursor()	Gets the next page cursor.
String	getPreviousCursor()	Gets the previous page cursor.
Boolean	hasNext()	Optional flag indicating whether there are more items after the current cursor.
Boolean	hasPrevious()	Optional flag indicating whether there are more items before the current cursor.

Methods inherited from class com.helixframework.api.contract.HateoasResponse

addLink, addLink, addLink, addLinks, getLinks, self

Methods inherited from class java.lang.Object

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

Constructor Details

HateoasBidiCursorPaginatedResponse

public HateoasBidiCursorPaginatedResponse()

Creates a new instance of HateoasBidiCursorPaginatedResponse.

HateoasBidiCursorPaginatedResponse

public HateoasBidiCursorPaginatedResponse(String nextCursor,
 String previousCursor,
 Collection<T> items)

Creates a new instance of HateoasBidiCursorPaginatedResponse.

Parameters:

nextCursor - next page cursor

previousCursor - previous page cursor

items - items

HateoasBidiCursorPaginatedResponse

public HateoasBidiCursorPaginatedResponse(String nextCursor,
 String previousCursor,
 Boolean hasNext,
 Boolean hasPrevious,
 Collection<T> items)

Creates a new instance of HateoasBidiCursorPaginatedResponse.

Parameters:

nextCursor - next page cursor

previousCursor - previous page cursor

hasNext - flag indicating whether items exist after the current cursor

hasPrevious - flag indicating whether items exist before the current cursor

items - items

Method Details

getCount

public int getCount()

Gets the number of items in the collection.

Returns:

number of items in collection

getNextCursor

public String getNextCursor()

Gets the next page cursor.

Returns:

next page cursor

getPreviousCursor

public String getPreviousCursor()

Gets the previous page cursor.

Returns:

previous page cursor

hasNext

public Boolean hasNext()

Optional flag indicating whether there are more items after the current cursor.

Returns:

true if there are items after the current cursor; otherwise false

hasPrevious

public Boolean hasPrevious()

Optional flag indicating whether there are more items before the current cursor.

Returns:

true if there are items before the current cursor; otherwise false

getItems

public List<T> getItems()

Gets the items.

Returns:

items