org.modeshape.jcr.federation.spi
Interface Pageable

All Known Implementing Classes:

GitConnector

public interface Pageable

Marker interface that should be implemented by Connector(s) that want to expose children of nodes in a "page by page" fashion. For effectively creating blocks of children for each page, connector implementations should use the PageWriter extension.

Method Summary

Document

getChildren(PageKey pageKey) Returns a document which represents a page of children.

Method Detail

getChildren

Document getChildren(PageKey pageKey)

Returns a document which represents a page of children. In order to add a next page, PageWriter.addPage(String, String, long, long) should be used to add a new page of children.

Parameters:

pageKey - a non-null PageKey instance, which offers information about the page that should be retrieved.

Returns:

either a non-null page document or null indicating that such a page doesn't exist