Package org.nuxeo.ecm.core.api.scroll

Interface ScrollRequest

All Known Implementing Classes:
DocumentScrollRequest, EmptyScrollRequest, GenericScrollRequest, StaticScrollRequest
public interface ScrollRequest
A Scroll request.
Since:
11.1

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    The Scroll implementation name.
    default String
    getReference()
    Gets a reference associated with the scroll request.
    int
    getSize()
    The number of items to return per iteration.
    String
    getType()
    The type of Scroll.

  • Method Details

    • getType

      String getType()
      The type of Scroll.

    • getName

      String getName()
      The Scroll implementation name. Returns null for default implementation.

    • getSize

      int getSize()
      The number of items to return per iteration.

    • getReference

      default String getReference()
      Gets a reference associated with the scroll request.
      Since:
      2021.44