com.independentsoft.exchange

Class FindItemResponse

java.lang.Object

com.independentsoft.exchange.Response

com.independentsoft.exchange.FindItemResponse

public class FindItemResponse
extends Response

Contains the status and result of a single FindItem Operation request.

Method Summary

Modifier and Type	Method and Description
int	getAbsoluteDenominator() Gets the next denominator to use for the next request when doing fractional paging.
java.util.List<Group>	getGroups() Gets a collection of items that are the result of a grouped FindItem Operation call.
java.util.List<HighlightTerm>	getHighlightTerms() Gets the highlight terms.
boolean	getIncludesLastItemInRange() Gets whether the current results contain the last item in the query, such that further paging is not needed.
int	getIndexedPagingOffset() Gets the next index that should be used for the next request when using an indexed paging view.
java.util.List<Item>	getItems() Gets a list of items found by using the FindItem Operation.
int	getNumeratorOffset() Gets the new numerator value to use for the next request when using fractional page views.
int	getTotalItemsInView() Gets the total number of items that pass the restriction.

Methods inherited from class com.independentsoft.exchange.Response

getDescriptiveLinkKey, getMessage, getResponseClass, getResponseCode, getServerVersionInfo, getXmlMessage, setServerVersionInfo

Methods inherited from class java.lang.Object

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

Method Detail

getIndexedPagingOffset

public int getIndexedPagingOffset()

Gets the next index that should be used for the next request when using an indexed paging view.

Returns:

the indexed paging offset

getNumeratorOffset

public int getNumeratorOffset()

Gets the new numerator value to use for the next request when using fractional page views.

Returns:

the numerator offset

getAbsoluteDenominator

public int getAbsoluteDenominator()

Gets the next denominator to use for the next request when doing fractional paging.

Returns:

the absolute denominator

getIncludesLastItemInRange

public boolean getIncludesLastItemInRange()

Gets whether the current results contain the last item in the query, such that further paging is not needed.

Returns:

the includes last item in range

getTotalItemsInView

public int getTotalItemsInView()

Gets the total number of items that pass the restriction.

Returns:

the total items in view

getItems

public java.util.List<Item> getItems()

Gets a list of items found by using the FindItem Operation.

Returns:

the items

getGroups

public java.util.List<Group> getGroups()

Gets a collection of items that are the result of a grouped FindItem Operation call.

Returns:

the groups

getHighlightTerms

public java.util.List<HighlightTerm> getHighlightTerms()

Gets the highlight terms.

Returns:

the highlight terms