I
- the type of items in your response (RepositoryItem, for example)public class ListingResponse<I>
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
The class version.
|
Constructor and Description |
---|
ListingResponse(ListingRequest pRequest)
Create a new instance based on a request.
|
Modifier and Type | Method and Description |
---|---|
int |
getCount()
Method to derive the number of results in this page response.
|
int |
getEndingIndex()
Gets the ending index
|
java.util.Collection<I> |
getItems() |
int |
getLimit()
Page size limit used for this response
|
ListingRequest |
getListingRequest()
Gets the listing request associated with this response
|
int |
getOffset()
Alias method to return the offset into the total available results that this page starts from.
|
SortDirectives |
getSort()
Gets the sort directives for this list
|
int |
getStartingIndex()
Gets the starting index
|
int |
getTotalNumberOfItems() |
int |
getTotalResults()
Alias method to return the total number of results.
|
boolean |
hasMore()
Method to derive whether there are any more pages after this response.
|
boolean |
isCollectionPaged()
Returns true if the listing response contains a paged set of items.
|
ListingResponse |
range(int pStartingIndex,
int pEndingIndex)
Sets the range for this ListingResults instance.
|
void |
setCollectionPaged(boolean pPagedCollection)
Set to true if the listing response contains a paged set of items.
|
ListingResponse |
setEndingIndex(int pEndingIndex)
Sets the ending index
|
ListingResponse |
setItems(java.util.Collection<I> pItems)
Sets the list of items in this list
|
ListingResponse |
setItems(java.util.Collection<I> pItems,
boolean pPagedCollection)
Sets the list of items in this list
|
void |
setLimit(int pLimit)
Page size limit used for this response.
|
void |
setListingRequest(ListingRequest pListingRequest)
Sets the listing request associated with this response
|
ListingResponse |
setSort(SortDirectives pSortDirectives)
Sets the sort directives for this list
|
ListingResponse |
setStartingIndex(int pStartingIndex)
Sets the starting index
|
ListingResponse |
setTotalNumberOfItems(int pTotalNumberOfItems)
Sets total number of items available in the collection of items available
for the criteria that created this list
|
java.lang.String |
toString() |
public ListingResponse(ListingRequest pRequest)
pRequest
- the request to copy properties from.public ListingResponse setTotalNumberOfItems(int pTotalNumberOfItems)
pTotalNumberOfItems
- total number of items availablepublic int getTotalNumberOfItems()
public ListingResponse setItems(java.util.Collection<I> pItems)
pItems
- the itemspublic ListingResponse setItems(java.util.Collection<I> pItems, boolean pPagedCollection)
pItems
- the itemspPagedCollection
- if this is the full collection or a paged set of itemspublic java.util.Collection<I> getItems()
public ListingResponse setStartingIndex(int pStartingIndex)
pStartingIndex
- the starting index of the set of items in this list (inclusive)public int getStartingIndex()
public ListingResponse setEndingIndex(int pEndingIndex)
pEndingIndex
- the ending index of the set of items in this list (exclusive)public int getEndingIndex()
public ListingResponse range(int pStartingIndex, int pEndingIndex)
pStartingIndex
- the starting index (inclusive)pEndingIndex
- the ending index (exclusive)public ListingResponse setSort(SortDirectives pSortDirectives)
pSortDirectives
- the sort directives for this listpublic SortDirectives getSort()
public void setListingRequest(ListingRequest pListingRequest)
pListingRequest
- Listing request usedpublic ListingRequest getListingRequest()
public void setLimit(int pLimit)
pLimit
- int page sizepublic int getLimit()
public boolean hasMore()
public int getTotalResults()
public int getCount()
public void setCollectionPaged(boolean pPagedCollection)
pPagedCollection
- int page sizepublic boolean isCollectionPaged()
public int getOffset()
public java.lang.String toString()
toString
in class java.lang.Object