microsoft.exchange.webservices.data
Class FindFoldersResults

java.lang.Object
  extended by microsoft.exchange.webservices.data.FindFoldersResults
All Implemented Interfaces:
java.lang.Iterable<Folder>

public final class FindFoldersResults
extends java.lang.Object
implements java.lang.Iterable<Folder>

Represents the results of a folder search operation.


Constructor Summary
protected FindFoldersResults()
          Initializes a new instance of the class.
 
Method Summary
 java.util.ArrayList<Folder> getFolders()
          Gets a collection containing the folders that were found by the search operation.
 java.lang.Integer getNextPageOffset()
          Gets the offset that should be used with FolderView to retrieve the next page of folders in a FindFolders operation.
 int getTotalCount()
          Gets the total number of folders matching the search criteria available in the searched folder.
 boolean isMoreAvailable()
          Gets a value indicating whether more folders matching the search criteria.
 java.util.Iterator<Folder> iterator()
          Returns an iterator that iterates through a collection.
protected  void setMoreAvailable(boolean moreAvailable)
          Sets a value indicating whether more folders matching the search criteria.
protected  void setNextPageOffset(java.lang.Integer nextPageOffset)
          Sets the offset that should be used with FolderView to retrieve the next page of folders in a FindFolders operation.
protected  void setTotalCount(int totalCount)
          Sets the total number of folders.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FindFoldersResults

protected FindFoldersResults()
Initializes a new instance of the class.

Method Detail

getTotalCount

public int getTotalCount()
Gets the total number of folders matching the search criteria available in the searched folder.

Returns:
the total count

setTotalCount

protected void setTotalCount(int totalCount)
Sets the total number of folders.

Parameters:
totalCount - the new total count

getNextPageOffset

public java.lang.Integer getNextPageOffset()
Gets the offset that should be used with FolderView to retrieve the next page of folders in a FindFolders operation.

Returns:
the next page offset

setNextPageOffset

protected void setNextPageOffset(java.lang.Integer nextPageOffset)
Sets the offset that should be used with FolderView to retrieve the next page of folders in a FindFolders operation.

Parameters:
nextPageOffset - the new next page offset

isMoreAvailable

public boolean isMoreAvailable()
Gets a value indicating whether more folders 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 folders matching the search criteria. are available in the searched folder.

Parameters:
moreAvailable - the new more available

getFolders

public java.util.ArrayList<Folder> getFolders()
Gets a collection containing the folders that were found by the search operation.

Returns:
the folders

iterator

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

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