microsoft.exchange.webservices.data.search

Class FindFoldersResults

java.lang.Object

microsoft.exchange.webservices.data.search.FindFoldersResults

All Implemented Interfaces:

Iterable<Folder>

public final class FindFoldersResults
extends Object
implements Iterable<Folder>

Represents the results of a folder search operation.

Constructor Summary

Constructors

Constructor and Description
FindFoldersResults() Initializes a new instance of the class.

Method Summary

Modifier and Type	Method and Description
ArrayList<Folder>	getFolders() Gets a collection containing the folder that were found by the search operation.
Integer	getNextPageOffset() Gets the offset that should be used with FolderView to retrieve the next page of folder in a FindFolders operation.
int	getTotalCount() Gets the total number of folder matching the search criteria available in the searched folder.
boolean	isMoreAvailable() Gets a value indicating whether more folder matching the search criteria. are available in the searched folder.
Iterator<Folder>	iterator() Returns an iterator that iterates through a collection.
void	setMoreAvailable(boolean moreAvailable) Sets a value indicating whether more folder matching the search criteria. are available in the searched folder.
void	setNextPageOffset(Integer nextPageOffset) Sets the offset that should be used with FolderView to retrieve the next page of folder in a FindFolders operation.
void	setTotalCount(int totalCount) Sets the total number of folder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FindFoldersResults

public FindFoldersResults()

Initializes a new instance of the class.

Method Detail

getTotalCount

public int getTotalCount()

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

Returns:

the total count

setTotalCount

public void setTotalCount(int totalCount)

Sets the total number of folder.

Parameters:

totalCount - the new total count

getNextPageOffset

public Integer getNextPageOffset()

Gets the offset that should be used with FolderView to retrieve the next page of folder in a FindFolders operation.

Returns:

the next page offset

setNextPageOffset

public void setNextPageOffset(Integer nextPageOffset)

Sets the offset that should be used with FolderView to retrieve the next page of folder in a FindFolders operation.

Parameters:

nextPageOffset - the new next page offset

isMoreAvailable

public boolean isMoreAvailable()

Gets a value indicating whether more folder matching the search criteria. are available in the searched folder.

Returns:

true, if is more available

setMoreAvailable

public void setMoreAvailable(boolean moreAvailable)

Sets a value indicating whether more folder matching the search criteria. are available in the searched folder.

Parameters:

moreAvailable - the new more available

getFolders

public ArrayList<Folder> getFolders()

Gets a collection containing the folder that were found by the search operation.

Returns:

the folder

iterator

public Iterator<Folder> iterator()

Returns an iterator that iterates through a collection.

Specified by:

iterator in interface Iterable<Folder>

Returns:

the iterator