|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ViewBase
microsoft.exchange.webservices.data.PagedView
public abstract class PagedView
Represents a view settings that support paging in a search operation.
Constructor Summary | |
---|---|
protected |
PagedView(int pageSize)
Initializes a new instance of the "PagedView" class. |
protected |
PagedView(int pageSize,
int offset)
Initializes a new instance of the "PagedView" class. |
protected |
PagedView(int pageSize,
int offset,
OffsetBasePoint offsetBasePoint)
Initializes a new instance of the "PagedView" class. |
Method Summary | |
---|---|
protected java.lang.Integer |
getMaxEntriesReturned()
Gets the maximum number of items or folders the search operation should return. |
int |
getOffset()
Gets the offset. |
OffsetBasePoint |
getOffsetBasePoint()
Gets the base point of the offset. |
int |
getPageSize()
Gets the maximum number of items or folders the search operation should return. |
protected void |
internalValidate(microsoft.exchange.webservices.data.ServiceRequestBase request)
Validates this view. |
protected void |
internalWriteSearchSettingsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
Grouping groupBy)
Internals the write search settings to XML. |
protected void |
internalWriteViewToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
Write to XML. |
void |
setOffset(int offset)
Sets the offset. |
void |
setOffsetBasePoint(OffsetBasePoint offsetBasePoint)
Sets the base point of the offset. |
void |
setPageSize(int pageSize)
Sets the maximum number of items or folders the search operation should return. |
protected void |
writeOrderByToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
Writes OrderBy property to XML. |
Methods inherited from class microsoft.exchange.webservices.data.ViewBase |
---|
getPropertySet, getPropertySetOrDefault, getServiceObjectType, getViewXmlElementName, setPropertySet, writeAttributesToXml, writeToXml |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected PagedView(int pageSize)
pageSize
- The maximum number of elements the search operation should
return.protected PagedView(int pageSize, int offset)
pageSize
- The maximum number of elements the search operation should
return.offset
- The offset of the view from the base point.protected PagedView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)
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 |
---|
protected void internalWriteViewToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) throws java.lang.Exception
internalWriteViewToXml
in class ViewBase
writer
- The Writer
java.lang.Exception
- the exceptionprotected java.lang.Integer getMaxEntriesReturned()
getMaxEntriesReturned
in class ViewBase
protected void internalWriteSearchSettingsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, Grouping groupBy) throws javax.xml.stream.XMLStreamException, ServiceXmlSerializationException
internalWriteSearchSettingsToXml
in class ViewBase
writer
- The writergroupBy
- The group by clause.
javax.xml.stream.XMLStreamException
- the xML stream exception
ServiceXmlSerializationException
- the service xml serialization exceptionprotected void writeOrderByToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) throws javax.xml.stream.XMLStreamException, ServiceXmlSerializationException
writeOrderByToXml
in class ViewBase
writer
- The Writer
javax.xml.stream.XMLStreamException
- the xML stream exception
ServiceXmlSerializationException
- the service xml serialization exceptionprotected void internalValidate(microsoft.exchange.webservices.data.ServiceRequestBase request) throws ServiceVersionException, ServiceValidationException
internalValidate
in class ViewBase
request
- The request using this view.
ServiceVersionException
- the service version exception
ServiceValidationException
- the service validation exceptionpublic int getPageSize()
public void setPageSize(int pageSize)
pageSize
- the new page sizepublic OffsetBasePoint getOffsetBasePoint()
public void setOffsetBasePoint(OffsetBasePoint offsetBasePoint)
offsetBasePoint
- the new offset base pointpublic int getOffset()
public void setOffset(int offset)
offset
- the new offset
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |