Class ConversationIndexedItemView
- java.lang.Object
-
- microsoft.exchange.webservices.data.search.ViewBase
-
- microsoft.exchange.webservices.data.search.PagedView
-
- microsoft.exchange.webservices.data.search.ConversationIndexedItemView
-
public final class ConversationIndexedItemView extends PagedView
Represents the view settings in a folder search operation.
-
-
Constructor Summary
Constructors Constructor Description ConversationIndexedItemView(int pageSize)Initializes a new instance of theItemViewclass.ConversationIndexedItemView(int pageSize, int offset)Initializes a new instance of theItemViewclass.ConversationIndexedItemView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)Initializes a new instance of theItemViewclass.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OrderByCollectiongetOrderBy()Gets the property against which the returned item should be ordered.protected ServiceObjectTypegetServiceObjectType()Gets the type of service object this view applies to.protected StringgetViewXmlElementName()Gets the name of the view XML element.voidinternalValidate(ServiceRequestBase request)Validates this view.protected voidinternalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy)Internals the write search settings to XML.voidwriteAttributesToXml(EwsServiceXmlWriter writer)Writes the attribute to XML.voidwriteOrderByToXml(EwsServiceXmlWriter writer)Writes OrderBy property to XML.voidwriteToXml(EwsServiceXmlWriter writer)Writes to XML.-
Methods inherited from class microsoft.exchange.webservices.data.search.PagedView
getMaxEntriesReturned, getOffset, getOffsetBasePoint, getPageSize, internalWriteViewToXml, setOffset, setOffsetBasePoint, setPageSize
-
Methods inherited from class microsoft.exchange.webservices.data.search.ViewBase
getPropertySet, getPropertySetOrDefault, setPropertySet, writeToXml
-
-
-
-
Constructor Detail
-
ConversationIndexedItemView
public ConversationIndexedItemView(int pageSize)
Initializes a new instance of theItemViewclass.- Parameters:
pageSize- The maximum number of elements the search operation should return.
-
ConversationIndexedItemView
public ConversationIndexedItemView(int pageSize, int offset)
Initializes a new instance of theItemViewclass.- Parameters:
pageSize- The maximum number of elements the search operation should return.offset- The offset of the view from the base point.
-
ConversationIndexedItemView
public ConversationIndexedItemView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)
Initializes a new instance of theItemViewclass.- Parameters:
pageSize- The maximum number of elements the search operation should return.offset- The offset of the view from the base point.offsetBasePoint- The base point of the offset.
-
-
Method Detail
-
getServiceObjectType
protected ServiceObjectType getServiceObjectType()
Gets the type of service object this view applies to.- Specified by:
getServiceObjectTypein classViewBase- Returns:
- A
ServiceObjectTypevalue.
-
writeAttributesToXml
public void writeAttributesToXml(EwsServiceXmlWriter writer)
Writes the attribute to XML.- Specified by:
writeAttributesToXmlin classViewBase- Parameters:
writer- The writer.
-
getViewXmlElementName
protected String getViewXmlElementName()
Gets the name of the view XML element.- Specified by:
getViewXmlElementNamein classViewBase- Returns:
- XML element name.
-
internalValidate
public void internalValidate(ServiceRequestBase request) throws ServiceVersionException, ServiceValidationException
Validates this view.- Overrides:
internalValidatein classPagedView- Parameters:
request- The request using this view.- Throws:
ServiceVersionException- the service version exceptionServiceValidationException- the service validation exception
-
internalWriteSearchSettingsToXml
protected void internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy) throws ServiceXmlSerializationException, XMLStreamException
Internals the write search settings to XML.- Overrides:
internalWriteSearchSettingsToXmlin classPagedView- Parameters:
writer- The writer.groupBy- The group by.- Throws:
ServiceXmlSerializationException- the service xml serialization exceptionXMLStreamException- the XML stream exception
-
writeOrderByToXml
public void writeOrderByToXml(EwsServiceXmlWriter writer) throws ServiceXmlSerializationException, XMLStreamException
Writes OrderBy property to XML.- Overrides:
writeOrderByToXmlin classPagedView- Parameters:
writer- The writer- Throws:
ServiceXmlSerializationException- the service xml serialization exceptionXMLStreamException- the XML stream exception
-
writeToXml
public void writeToXml(EwsServiceXmlWriter writer) throws Exception
Writes to XML.- Parameters:
writer- The writer- Throws:
Exception
-
getOrderBy
public OrderByCollection getOrderBy()
Gets the property against which the returned item should be ordered.
-
-