microsoft.exchange.webservices.data.PagedView 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="PagedView.java" company="Microsoft"
 *     Copyright (c) Microsoft Corporation.  All rights reserved.
 * 
 * Defines the PagedView.java.
 **************************************************************************/
package microsoft.exchange.webservices.data;

import javax.xml.stream.XMLStreamException;

/**
 * Represents a view settings that support paging in a search operation.
 * 
 * 
 */
@EditorBrowsable(state = EditorBrowsableState.Never)
public abstract class PagedView extends ViewBase {

	/** The page size. */
	private int pageSize;

	/** The offset base point. */
	private OffsetBasePoint offsetBasePoint = OffsetBasePoint.Beginning;

	/** The offset. */
	private int offset;

	/**
	 * Write to XML.
	 * 
	 * @param writer
	 *            The Writer
	 * @throws Exception
	 *             the exception
	 */
	@Override
	protected void internalWriteViewToXml(EwsServiceXmlWriter writer)
			throws Exception {
		super.internalWriteViewToXml(writer);

		writer.writeAttributeValue(XmlAttributeNames.Offset, this.getOffset());
		writer.writeAttributeValue(XmlAttributeNames.BasePoint, this
				.getOffsetBasePoint());
	}

	/**
	 * Gets the maximum number of items or folders the search operation should
	 * return.
	 * 
	 * @return The maximum number of items or folders that should be returned by
	 *         the search operation.
	 */
	@Override
	protected Integer getMaxEntriesReturned() {
		return this.getPageSize();
	}

	/**
	 * Internals the write search settings to XML.
	 * 
	 * @param writer 
	 * 				The writer
	 * @param groupBy 
	 * 				The group by clause.
	 * @throws XMLStreamException 
	 * 				the xML stream exception
	 * @throws ServiceXmlSerializationException 
	 * 				the service xml serialization exception
	 */
	@Override
	protected void internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer,
			Grouping groupBy) throws XMLStreamException,
			ServiceXmlSerializationException {
		if (groupBy != null) {
			groupBy.writeToXml(writer);
		}
	}

	/**
	 * Writes OrderBy property to XML.
	 * 
	 * @param writer
	 *            The Writer
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws ServiceXmlSerializationException
	 *             the service xml serialization exception
	 */
	@Override
	protected void writeOrderByToXml(EwsServiceXmlWriter writer)
			throws XMLStreamException, ServiceXmlSerializationException {
		// No order by for paged view
	}

	/**
	 * Validates this view.
	 * 
	 * @param request
	 *            The request using this view.
	 * @throws ServiceVersionException
	 *             the service version exception
	 * @throws ServiceValidationException
	 *             the service validation exception
	 */
	@Override
	protected void internalValidate(ServiceRequestBase request)
			throws ServiceVersionException, ServiceValidationException {
		super.internalValidate(request);
	}

	/**
	 * Initializes a new instance of the "PagedView" class.
	 * 
	 * @param pageSize
	 *            The maximum number of elements the search operation should
	 *            return.
	 */
	protected PagedView(int pageSize) {
		super();
		this.setPageSize(pageSize);
	}

	/**
	 * Initializes a new instance of the "PagedView" class.
	 * 
	 * @param pageSize
	 *            The maximum number of elements the search operation should
	 *            return.
	 * @param offset
	 *            The offset of the view from the base point.
	 */
	protected PagedView(int pageSize, int offset) {
		this(pageSize);
		this.setOffset(offset);
	}

	/**
	 * Initializes a new instance of the "PagedView" class.
	 * 
	 * @param pageSize
	 *            The maximum number of elements the search operation should
	 *            return.
	 * @param offset
	 *            The offset of the view from the base point.
	 * @param offsetBasePoint
	 *            The base point of the offset.
	 */
	protected PagedView(int pageSize, int offset,
			OffsetBasePoint offsetBasePoint) {
		this(pageSize, offset);
		this.setOffsetBasePoint(offsetBasePoint);
	}

	/**
	 * Gets the maximum number of items or folders the search operation should
	 * return.
	 * 
	 * @return the page size
	 */
	public int getPageSize() {
		return pageSize;
	}

	/**
	 * Sets the maximum number of items or folders the search operation should
	 * return.
	 * 
	 * @param pageSize
	 *            the new page size
	 */
	public void setPageSize(int pageSize) {
		if (pageSize <= 0) {
			throw new IllegalArgumentException(
					Strings.ValueMustBeGreaterThanZero);
		}
		this.pageSize = pageSize;
	}

	/**
	 * Gets the base point of the offset.
	 * 
	 * @return the offset base point
	 */
	public OffsetBasePoint getOffsetBasePoint() {
		return offsetBasePoint;
	}

	/**
	 * Sets the base point of the offset.
	 * 
	 * @param offsetBasePoint
	 *            the new offset base point
	 */
	public void setOffsetBasePoint(OffsetBasePoint offsetBasePoint) {
		this.offsetBasePoint = offsetBasePoint;
	}

	/**
	 * Gets the offset.
	 * 
	 * @return the offset
	 */
	public int getOffset() {
		return offset;
	}

	/**
	 * Sets the offset.
	 * 
	 * @param offset
	 *            the new offset
	 */
	public void setOffset(int offset) {
		if (offset >= 0) {
			this.offset = offset;
		} else {
			throw new IllegalArgumentException(
					Strings.OffsetMustBeGreaterThanZero);
		}
	}

}