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

java.lang.Object
  extended by microsoft.exchange.webservices.data.FindItemsResults<TItem>
Type Parameters:
TItem - The type of item returned by the search operation.
All Implemented Interfaces:
java.lang.Iterable<Item>

public final class FindItemsResults<TItem extends Item>
extends java.lang.Object
implements java.lang.Iterable<Item>

Represents the results of an item search operation.


Constructor Summary
protected FindItemsResults()
          Initializes a new instance of the FindItemsResults class.
 
Method Summary
 java.util.ArrayList<TItem> getItems()
          Gets a collection containing the items that were found by the search operation.
 java.lang.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 matching the search criteria are available in the searched folder.
 java.util.Iterator<Item> iterator()
          Returns an iterator that iterates through the collection.
protected  void setMoreAvailable(boolean moreAvailable)
          Sets a value indicating whether more items matching the search criteria are available in the searched folder.
protected  void setNextPageOffset(java.lang.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)
          Sets 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

FindItemsResults

protected FindItemsResults()
Initializes a new instance of the FindItemsResults 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)
Sets the total number of items matching the search criteria available in the searched folder.

Parameters:
totalCount - the new total count

getNextPageOffset

public java.lang.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(java.lang.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 matching 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 matching the search criteria are available in the searched folder.

Parameters:
moreAvailable - the new more available

getItems

public java.util.ArrayList<TItem> getItems()
Gets a collection containing the items that were found by the search operation.

Returns:
the items

iterator

public java.util.Iterator<Item> iterator()
Returns an iterator that iterates through the collection.

Specified by:
iterator in interface java.lang.Iterable<Item>
Returns:
the iterator