com.ithit.webdav.server.paging

Class PageResults

java.lang.Object

com.ithit.webdav.server.paging.PageResults

public class PageResults
extends Object

Represents a single page results returned from the Folder.getChildren(List, Long, Long, List) and Search.search(String, SearchOptions, List, Long, Long) methods.

Constructor Summary

Constructors

Constructor and Description
PageResults(List<? extends HierarchyItem> page, Long totalItems) Initializes a new instance of the PageResults class.

Method Summary

Modifier and Type	Method and Description
List<? extends HierarchyItem>	getPage() Items that correspond to the requested page and sorting.
Long	getTotalItems() Total number of items in the folder or in search results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageResults

public PageResults(List<? extends HierarchyItem> page,
                   Long totalItems)

Initializes a new instance of the PageResults class.

Parameters:

page - Items that correspond to the requested page and sorting.

totalItems - Total number of items in the folder or in search results.

Method Detail

getPage

public List<? extends HierarchyItem> getPage()

Items that correspond to the requested page and sorting.

Returns:

List of items that represent items on a page.

getTotalItems

public Long getTotalItems()

Total number of items in the folder or in search results. This number can be used by the client application to display number of pages available. Set this property to null if total number of items is unknown. The total number of items will not be returned to the client in this case.

Returns:

number of total items.