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

import java.util.Date;

import javax.xml.stream.XMLStreamException;

/**
 * Represents an event as exposed by push and pull notifications.
 * 
 */
public abstract class NotificationEvent {

	/**
	 * Type of this event.
	 */
	private EventType eventType;

	/**
	 * Date and time when the event occurred.
	 */
	private Date timestamp;

	/**
	 * Id of parent folder of the item or folder this event applies to.
	 */
	private FolderId parentFolderId;

	/**
	 * Id of the old parent folder of the item or folder this event applies to.
	 * This property is only meaningful when EventType is equal to either
	 * EventType.Moved or EventType.Copied. For all other event types,
	 * oldParentFolderId will be null
	 */
	private FolderId oldParentFolderId;

	/**
	 * Initializes a new instance.
	 * 
	 * @param eventType
	 *            the event type
	 * @param timestamp
	 *            the timestamp
	 */
	protected NotificationEvent(EventType eventType, Date timestamp) {
		this.eventType = eventType;
		this.timestamp = timestamp;
	}

	/**
	 * Load from XML.
	 * 
	 * @param reader
	 *            the reader
	 * @throws ServiceXmlDeserializationException
	 *             the service xml deserialization exception
	 * @throws XMLStreamException
	 *             the xML stream exception
	 * @throws InstantiationException
	 *             the instantiation exception
	 * @throws IllegalAccessException
	 *             the illegal access exception
	 * @throws Exception
	 *             the exception
	 */
	protected void internalLoadFromXml(EwsServiceXmlReader reader)
			throws ServiceXmlDeserializationException, XMLStreamException,
			InstantiationException, IllegalAccessException, Exception {
	}

	/**
	 * Loads this NotificationEvent from XML.
	 * 
	 * @param reader
	 *            the reader
	 * @param xmlElementName
	 *            the xml element name
	 * @throws Exception
	 *             the exception
	 */
	protected void loadFromXml(EwsServiceXmlReader reader,
			String xmlElementName)
			throws Exception {
		this.internalLoadFromXml(reader);

		reader.readEndElementIfNecessary(XmlNamespace.Types, xmlElementName);
	}

	/**
	 * gets the eventType.
	 * 
	 * @return the eventType.
	 * 
	 */
	public EventType getEventType() {
		return eventType;
	}

	/**
	 * gets the timestamp.
	 * 
	 * @return the timestamp.
	 * 
	 */
	public Date getTimestamp() {
		return timestamp;
	}

	/**
	 * gets the parentFolderId.
	 * 
	 * @return the parentFolderId.
	 * 
	 */
	public FolderId getParentFolderId() {
		return parentFolderId;
	}

	/**
	 * Sets the parentFolderId.
	 * 
	 * @param parentFolderId
	 *            the new parent folder id
	 */
	protected void setParentFolderId(FolderId parentFolderId) {
		this.parentFolderId = parentFolderId;
	}

	/**
	 * gets the oldParentFolderId.
	 * 
	 * @return the oldParentFolderId.
	 * 
	 */
	public FolderId getOldParentFolderId() {
		return oldParentFolderId;
	}

	/**
	 * Sets the oldParentFolderId.
	 * 
	 * @param oldParentFolderId
	 *            the new old parent folder id
	 */
	protected void setOldParentFolderId(FolderId oldParentFolderId) {

		this.oldParentFolderId = oldParentFolderId;
	}

}