microsoft.exchange.webservices.data.ViewBase 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
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="ViewBase.java" company="Microsoft"
* Copyright (c) Microsoft Corporation. All rights reserved.
*
* Defines the ViewBase.java.
**************************************************************************/
package microsoft.exchange.webservices.data;
import javax.xml.stream.XMLStreamException;
/**
* Represents the base view class for search operations.
*
*/
@EditorBrowsable(state = EditorBrowsableState.Never)
public abstract class ViewBase {
/** The property set. */
private PropertySet propertySet;
/**
* Initializes a new instance of the "ViewBase" class.
*/
ViewBase() {
}
/**
* Validates this view.
*
* @param request
* The request using this view.
* @throws ServiceValidationException
* the service validation exception
* @throws ServiceVersionException
* the service version exception
*/
protected void internalValidate(ServiceRequestBase request)
throws ServiceValidationException, ServiceVersionException {
if (this.getPropertySet() != null) {
this.getPropertySet().internalValidate();
this.getPropertySet().validateForRequest(
request,
true /* summaryPropertiesOnly */);
}
}
/**
* Writes this view to XML.
*
* @param writer
* The writer
* @throws ServiceXmlSerializationException
* the service xml serialization exception
* @throws Exception
* the exception
*/
protected void internalWriteViewToXml(EwsServiceXmlWriter writer)
throws ServiceXmlSerializationException, Exception {
Integer maxEntriesReturned = this.getMaxEntriesReturned();
if (maxEntriesReturned != null) {
writer.writeAttributeValue(XmlAttributeNames.MaxEntriesReturned,
maxEntriesReturned);
}
}
/**
* Writes the 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
*/
protected abstract void internalWriteSearchSettingsToXml(
EwsServiceXmlWriter writer, Grouping groupBy)
throws XMLStreamException, ServiceXmlSerializationException;
/**
* Writes OrderBy property to XML.
*
* @param writer
* The Writer
* @throws XMLStreamException
* the xML stream exception
* @throws ServiceXmlSerializationException
* the service xml serialization exception
*/
protected abstract void writeOrderByToXml(EwsServiceXmlWriter writer)
throws XMLStreamException, ServiceXmlSerializationException;
/**
* Gets the name of the view XML element.
*
* @return TheXml Element name
*/
protected abstract String getViewXmlElementName();
/**
* 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.
*/
protected abstract Integer getMaxEntriesReturned();
/**
* Gets the type of service object this view applies to.
*
* @return A ServiceObjectType value.
*/
protected abstract ServiceObjectType getServiceObjectType();
/**
* Writes the attributes to XML.
*
* @param writer
* The writer.
* @throws ServiceXmlSerializationException
* the service xml serialization exception
*/
protected abstract void writeAttributesToXml(EwsServiceXmlWriter writer)
throws ServiceXmlSerializationException;
/**
* Writes to XML.
*
* @param writer
* The writer.
* @param groupBy
* The group by clause.
* @throws Exception
* the exception
*/
protected void writeToXml(EwsServiceXmlWriter writer, Grouping groupBy)
throws Exception {
this.getPropertySetOrDefault().writeToXml(writer,
this.getServiceObjectType());
writer.writeStartElement(XmlNamespace.Messages, this
.getViewXmlElementName());
this.internalWriteViewToXml(writer);
writer.writeEndElement(); // this.GetViewXmlElementName()
this.internalWriteSearchSettingsToXml(writer, groupBy);
}
/**
* Gets the property set or the default.
*
* @return PropertySet
*/
protected PropertySet getPropertySetOrDefault() {
if (this.getPropertySet() == null) {
return PropertySet.getFirstClassProperties();
} else {
return this.getPropertySet();
}
}
/**
* Gets the property set. PropertySet determines which properties will be
* loaded on found items. If PropertySet is null, all first class properties
* are loaded on found items.
*
* @return the property set
*/
public PropertySet getPropertySet() {
return propertySet;
}
/**
* Sets the property set. PropertySet determines which properties will be
* loaded on found items. If PropertySet is null, all first class properties
* are loaded on found items.
*
* @param propertySet
* The property set
*/
public void setPropertySet(PropertySet propertySet) {
this.propertySet = propertySet;
}
}