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

Go to download
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="FindItemsResults.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the FindItemsResults.java.
 **************************************************************************/

package microsoft.exchange.webservices.data;

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

/**
 * 
 * Represents the results of an item search operation.
 * 
 * @param 
 *            The type of item returned by the search operation.
 */
public final class FindItemsResults implements
		Iterable {

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

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

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

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

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

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

	/**
	 * Sets the total number of items matching the search criteria available in
	 * the searched folder.
	 * 
	 * @param totalCount
	 *            the new total count
	 */
	protected void setTotalCount(int totalCount) {
		this.totalCount = totalCount;
	}

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

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

	/**
	 * Gets a value indicating whether more items 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 items 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 items that were found by the search
	 * operation.
	 * 
	 * @return the items
	 */
	public ArrayList getItems() {
		return this.items;
	}

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

}