org.modeshape.jcr.spi.federation

## Interface Pageable

- All Known Implementing Classes:
    FileSystemConnector, GitConnector, LargeFileSystemConnector

      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

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Document` | `getChildren(PageKey pageKey)` Returns a document which represents the document of a parent node to which an optional 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 optional 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.

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