microsoft.exchange.webservices.data.FindFoldersResults Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of exchange-ws-api Show documentation

The source came from http://archive.msdn.microsoft.com/ewsjavaapi Support for Maven has been added.

The newest version!

/**************************************************************************
 * copyright file="FindFoldersResults.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the FindFoldersResults.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import java.util.ArrayList;
import java.util.Iterator;

/**
 * Represents the results of a folder search operation.
 */
public final class FindFoldersResults implements Iterable {

	/** The total count. */
	private int totalCount;

	/** The next page offset. */
	private Integer nextPageOffset;

	/** The more available. */
	private boolean moreAvailable;

	/** The folders. */
	private ArrayList folders = new ArrayList();

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

	}

	/**
	 * Gets the total number of folders matching the search criteria available
	 * in the searched folder.
	 * 
	 * @return the total count
	 */
	public int getTotalCount() {
		return totalCount;
	}

	/**
	 * Sets the total number of folders.
	 * 
	 * @param totalCount
	 *            the new total count
	 */
	protected void setTotalCount(int totalCount) {
		this.totalCount = totalCount;
	}

	/**
	 * Gets the offset that should be used with FolderView to retrieve the next
	 * page of folders in a FindFolders operation.
	 * 
	 * @return the next page offset
	 */
	public Integer getNextPageOffset() {
		return nextPageOffset;
	}

	/**
	 * Sets the offset that should be used with FolderView to retrieve the next
	 * page of folders in a FindFolders operation.
	 * 
	 * @param nextPageOffset
	 *            the new next page offset
	 */
	protected void setNextPageOffset(Integer nextPageOffset) {
		this.nextPageOffset = nextPageOffset;
	}

	/**
	 * Gets a value indicating whether more folders matching the search
	 * criteria. are available in the searched folder.
	 * 
	 * @return true, if is more available
	 */
	public boolean isMoreAvailable() {
		return moreAvailable;
	}

	/**
	 * Sets a value indicating whether more folders matching the search
	 * criteria. are available in the searched folder.
	 * 
	 * @param moreAvailable
	 *            the new more available
	 */
	protected void setMoreAvailable(boolean moreAvailable) {
		this.moreAvailable = moreAvailable;
	}

	/**
	 * Gets a collection containing the folders that were found by the search
	 * operation.
	 * 
	 * @return the folders
	 */
	public ArrayList getFolders() {
		return folders;
	}

	/**
	 * Returns an iterator that iterates through a collection.
	 * 
	 * @return the iterator
	 */
	@Override
	public Iterator iterator() {
		return this.folders.iterator();
	}

}