Interface SerializablePagedCollection<T>
-
- All Known Implementing Classes:
CollectionWithPagingInfo
public interface SerializablePagedCollection<T>
A specialist representation of a Collection that can be serialized to json with paging information- Author:
- Gethin James.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Collection<T>
getCollection()
Returns the Collection objectSearchContext
getContext()
The search context for the collectionPaging
getPaging()
The requested paging parameters set by the clientjava.lang.Object
getSourceEntity()
The parent/source entity responsible for the collectionjava.lang.Integer
getTotalItems()
Indicates the total number of items available.boolean
hasMoreItems()
Indicates if the returned collection has more items after the current returned list.
-
-
-
Method Detail
-
getCollection
java.util.Collection<T> getCollection()
Returns the Collection object- Returns:
- Collection
-
hasMoreItems
boolean hasMoreItems()
Indicates if the returned collection has more items after the current returned list.
-
getTotalItems
java.lang.Integer getTotalItems()
Indicates the total number of items available. Can be greater than the number of items returned in the list.
-
getSourceEntity
java.lang.Object getSourceEntity()
The parent/source entity responsible for the collection
-
getPaging
Paging getPaging()
The requested paging parameters set by the client
-
getContext
SearchContext getContext()
The search context for the collection
-
-