microsoft.exchange.webservices.data
Class GroupedFindItemsResults<TItem extends Item>

java.lang.Object
  microsoft.exchange.webservices.data.GroupedFindItemsResults<TItem>

Type Parameters:

TItem - The type of item returned by the search operation.

All Implemented Interfaces:

Iterable<ItemGroup<TItem>>

public final class GroupedFindItemsResults<TItem extends Item>
extends Object
implements Iterable<ItemGroup<TItem>>

Represents the results of an item search operation.

Constructor Summary

protected

GroupedFindItemsResults() Initializes a new instance of the GroupedFindItemsResults class.

Method Summary

ArrayList<ItemGroup<TItem>>	getItemGroups() Gets the item groups returned by the search operation.
Integer	getNextPageOffset() Gets the offset that should be used with ItemView to retrieve the next page of items in a FindItems operation.
int	getTotalCount() Gets the total number of items matching the search criteria available in the searched folder.
boolean	isMoreAvailable() Gets a value indicating whether more items corresponding to the search criteria are available in the searched folder.
Iterator<ItemGroup<TItem>>	iterator() Returns an iterator that iterates through the collection.
protected void	setMoreAvailable(boolean moreAvailable) Sets a value indicating whether more items corresponding to the search criteria are available in the searched folder.
protected void	setNextPageOffset(Integer nextPageOffset) Sets the offset that should be used with ItemView to retrieve the next page of items in a FindItems operation.
protected void	setTotalCount(int totalCount) Gets the total number of items matching the search criteria available in the searched folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupedFindItemsResults

protected GroupedFindItemsResults()

Initializes a new instance of the GroupedFindItemsResults class.

Method Detail

getTotalCount

public int getTotalCount()

Gets the total number of items matching the search criteria available in the searched folder.

Returns:

the total count

setTotalCount

protected void setTotalCount(int totalCount)

Gets the total number of items matching the search criteria available in the searched folder.

Parameters:

totalCount - Total number of items

getNextPageOffset

public Integer getNextPageOffset()

Gets the offset that should be used with ItemView to retrieve the next page of items in a FindItems operation.

Returns:

the next page offset

setNextPageOffset

protected void setNextPageOffset(Integer nextPageOffset)

Sets the offset that should be used with ItemView to retrieve the next page of items in a FindItems operation.

Parameters:

nextPageOffset - the new next page offset

isMoreAvailable

public boolean isMoreAvailable()

Gets a value indicating whether more items corresponding to the search criteria are available in the searched folder.

Returns:

true, if is more available

setMoreAvailable

protected void setMoreAvailable(boolean moreAvailable)

Sets a value indicating whether more items corresponding to the search criteria are available in the searched folder.

Parameters:

moreAvailable - the new more available

getItemGroups

public ArrayList<ItemGroup<TItem>> getItemGroups()

Gets the item groups returned by the search operation.

Returns:

the item groups

iterator

public Iterator<ItemGroup<TItem>> iterator()

Returns an iterator that iterates through the collection.

Specified by:

iterator in interface Iterable<ItemGroup<TItem extends Item>>

Returns:

the iterator