Class PagedView
- java.lang.Object
-
- microsoft.exchange.webservices.data.search.ViewBase
-
- microsoft.exchange.webservices.data.search.PagedView
-
- Direct Known Subclasses:
ConversationIndexedItemView,FolderView,ItemView
public abstract class PagedView extends ViewBase
Represents a view settings that support paging in a search operation.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedPagedView(int pageSize)Initializes a new instance of the "PagedView" class.protectedPagedView(int pageSize, int offset)Initializes a new instance of the "PagedView" class.protectedPagedView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)Initializes a new instance of the "PagedView" class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected IntegergetMaxEntriesReturned()Gets the maximum number of item or folder the search operation should return.intgetOffset()Gets the offset.OffsetBasePointgetOffsetBasePoint()Gets the base point of the offset.intgetPageSize()Gets the maximum number of item or folder the search operation should return.voidinternalValidate(ServiceRequestBase request)Validates this view.protected voidinternalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy)Internals the write search settings to XML.protected voidinternalWriteViewToXml(EwsServiceXmlWriter writer)Write to XML.voidsetOffset(int offset)Sets the offset.voidsetOffsetBasePoint(OffsetBasePoint offsetBasePoint)Sets the base point of the offset.voidsetPageSize(int pageSize)Sets the maximum number of item or folder the search operation should return.voidwriteOrderByToXml(EwsServiceXmlWriter writer)Writes OrderBy property to XML.-
Methods inherited from class microsoft.exchange.webservices.data.search.ViewBase
getPropertySet, getPropertySetOrDefault, getServiceObjectType, getViewXmlElementName, setPropertySet, writeAttributesToXml, writeToXml
-
-
-
-
Constructor Detail
-
PagedView
protected PagedView(int pageSize)
Initializes a new instance of the "PagedView" class.- Parameters:
pageSize- The maximum number of elements the search operation should return.
-
PagedView
protected PagedView(int pageSize, int offset)
Initializes a new instance of the "PagedView" class.- Parameters:
pageSize- The maximum number of elements the search operation should return.offset- The offset of the view from the base point.
-
PagedView
protected PagedView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)
Initializes a new instance of the "PagedView" class.- 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
-
internalWriteViewToXml
protected void internalWriteViewToXml(EwsServiceXmlWriter writer) throws Exception
Write to XML.- Overrides:
internalWriteViewToXmlin classViewBase- Parameters:
writer- The Writer- Throws:
Exception- the exception
-
getMaxEntriesReturned
protected Integer getMaxEntriesReturned()
Gets the maximum number of item or folder the search operation should return.- Specified by:
getMaxEntriesReturnedin classViewBase- Returns:
- The maximum number of item or folder that should be returned by the search operation.
-
internalWriteSearchSettingsToXml
protected void internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy) throws XMLStreamException, ServiceXmlSerializationException
Internals the write search settings to XML.- Specified by:
internalWriteSearchSettingsToXmlin classViewBase- Parameters:
writer- the writergroupBy- the group by clause- Throws:
XMLStreamException- the XML stream exceptionServiceXmlSerializationException- the service xml serialization exception
-
writeOrderByToXml
public void writeOrderByToXml(EwsServiceXmlWriter writer) throws XMLStreamException, ServiceXmlSerializationException
Writes OrderBy property to XML.- Specified by:
writeOrderByToXmlin classViewBase- Parameters:
writer- the writer- Throws:
XMLStreamException- the XML stream exceptionServiceXmlSerializationException- the service xml serialization exception
-
internalValidate
public void internalValidate(ServiceRequestBase request) throws ServiceVersionException, ServiceValidationException
Validates this view.- Overrides:
internalValidatein classViewBase- Parameters:
request- The request using this view.- Throws:
ServiceVersionException- the service version exceptionServiceValidationException- the service validation exception
-
getPageSize
public int getPageSize()
Gets the maximum number of item or folder the search operation should return.- Returns:
- the page size
-
setPageSize
public void setPageSize(int pageSize)
Sets the maximum number of item or folder the search operation should return.- Parameters:
pageSize- the new page size
-
getOffsetBasePoint
public OffsetBasePoint getOffsetBasePoint()
Gets the base point of the offset.- Returns:
- the offset base point
-
setOffsetBasePoint
public void setOffsetBasePoint(OffsetBasePoint offsetBasePoint)
Sets the base point of the offset.- Parameters:
offsetBasePoint- the new offset base point
-
getOffset
public int getOffset()
Gets the offset.- Returns:
- the offset
-
setOffset
public void setOffset(int offset)
Sets the offset.- Parameters:
offset- the new offset
-
-