atg.servlet

Class ListingResponse<I>

java.lang.Object

atg.servlet.ListingResponse<I>

Type Parameters:

I - the type of items in your response (RepositoryItem, for example)

public class ListingResponse<I>
extends java.lang.Object

A simple bean that encapsulates information about a listing response that is used as a result of a query for a set of items. The set of items returned may be a subset of the whole, so this class allows the caller to define properties that describe this returned set e.g. the starting and ending indexes for ranged queries, sort criteria if the results are sorted, and the total number of items possibly available in the set

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION The class version.

Constructor Summary

Constructors

Constructor and Description
ListingResponse(ListingRequest pRequest) Create a new instance based on a request.

Method Summary

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()

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

The class version.

Constructor Detail

ListingResponse

public ListingResponse(ListingRequest pRequest)

Create a new instance based on a request. Copies sortDirectives, startingIndex and endingIndex.

Parameters:

pRequest - the request to copy properties from.

Method Detail

setTotalNumberOfItems

public ListingResponse setTotalNumberOfItems(int pTotalNumberOfItems)

Sets total number of items available in the collection of items available for the criteria that created this list

Parameters:

pTotalNumberOfItems - total number of items available

Returns:

this ListingResults instance

getTotalNumberOfItems

public int getTotalNumberOfItems()

Returns:

the total number of items available in the collection of items available for the criteria that created this list. If this has not been explicitly set, then this will return a value of -1, even if the items contained in this result represent the entire available set.

setItems

public ListingResponse setItems(java.util.Collection<I> pItems)

Sets the list of items in this list

Parameters:

pItems - the items

Returns:

this ListingResponse instance

setItems

public ListingResponse setItems(java.util.Collection<I> pItems,
                                boolean pPagedCollection)

Sets the list of items in this list

Parameters:

pItems - the items

pPagedCollection - if this is the full collection or a paged set of items

Returns:

this ListingResponse instance

getItems

public java.util.Collection<I> getItems()

Returns:

the list of items in this list

setStartingIndex

public ListingResponse setStartingIndex(int pStartingIndex)

Sets the starting index

Parameters:

pStartingIndex - the starting index of the set of items in this list (inclusive)

Returns:

this ListingResults instance

getStartingIndex

public int getStartingIndex()

Gets the starting index

Returns:

the starting index of the set of items in this list (inclusive)

setEndingIndex

public ListingResponse setEndingIndex(int pEndingIndex)

Sets the ending index

Parameters:

pEndingIndex - the ending index of the set of items in this list (exclusive)

Returns:

this ListingResults instance

getEndingIndex

public int getEndingIndex()

Gets the ending index

Returns:

the ending index of the set of items in this list (exclusive)

range

public ListingResponse range(int pStartingIndex,
                             int pEndingIndex)

Sets the range for this ListingResults instance.

Parameters:

pStartingIndex - the starting index (inclusive)

pEndingIndex - the ending index (exclusive)

Returns:

this ListingResults instance

setSort

public ListingResponse setSort(SortDirectives pSortDirectives)

Sets the sort directives for this list

Parameters:

pSortDirectives - the sort directives for this list

Returns:

this ListingResults instance

getSort

public SortDirectives getSort()

Gets the sort directives for this list

Returns:

the sort directives for this list

setListingRequest

public void setListingRequest(ListingRequest pListingRequest)

Sets the listing request associated with this response

Parameters:

pListingRequest - Listing request used

getListingRequest

public ListingRequest getListingRequest()

Gets the listing request associated with this response

Returns:

listing request used

setLimit

public void setLimit(int pLimit)

Page size limit used for this response.

Parameters:

pLimit - int page size

getLimit

public int getLimit()

Page size limit used for this response

Returns:

page size limit

hasMore

public boolean hasMore()

Method to derive whether there are any more pages after this response.

Returns:

true if there are more pages else false

getTotalResults

public int getTotalResults()

Alias method to return the total number of results.

Returns:

the total number of available results.

getCount

public int getCount()

Method to derive the number of results in this page response.

Returns:

number of results in this page response

setCollectionPaged

public void setCollectionPaged(boolean pPagedCollection)

Set to true if the listing response contains a paged set of items. Or false if the listing response items is the full collection.

Parameters:

pPagedCollection - int page size

isCollectionPaged

public boolean isCollectionPaged()

Returns true if the listing response contains a paged set of items. Or false if it is the full collection, i.e. the paging offset and limit were not applied upon retrieval.

Returns:

a boolean indicating the collection of items are paged.

getOffset

public int getOffset()

Alias method to return the offset into the total available results that this page starts from.

Returns:

the offset into the total available results that this page starts from.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object