ModeShape Distribution 3.5.0.Final

org.modeshape.jcr.federation.spi
Interface Pageable

All Known Implementing Classes:
FileSystemConnector, GitConnector

public interface Pageable

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 the document of a parent node to which an optiona page of children has been added.
 

Method Detail

getChildren

Document getChildren(PageKey pageKey)
Returns a document which represents the document of a parent node to which an optiona page of children has been added. 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:
a non-null document representing the parent document.

ModeShape Distribution 3.5.0.Final

Copyright © 2008-2013 JBoss, a division of Red Hat. All Rights Reserved.