Package org.nuxeo.ecm.core.scroll
Class DocumentScrollRequest
- java.lang.Object
-
- org.nuxeo.ecm.core.scroll.DocumentScrollRequest
-
- All Implemented Interfaces:
ScrollRequest
public class DocumentScrollRequest extends Object implements ScrollRequest
Request to scroll documents.- Since:
- 11.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DocumentScrollRequest.Builder
-
Constructor Summary
Constructors Modifier Constructor Description protected
DocumentScrollRequest(DocumentScrollRequest.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DocumentScrollRequest.Builder
builder(String nxqlQuery)
Creates a builder using an NXQL query.String
getName()
The Scroll implementation name.String
getQuery()
String
getRepository()
int
getSize()
The number of items to return per iteration.Duration
getTimeout()
String
getType()
The type of Scroll.String
getUsername()
String
toString()
-
-
-
Field Detail
-
SCROLL_TYPE
protected static final String SCROLL_TYPE
- See Also:
- Constant Field Values
-
repository
protected final String repository
-
size
protected final int size
-
-
Constructor Detail
-
DocumentScrollRequest
protected DocumentScrollRequest(DocumentScrollRequest.Builder builder)
-
-
Method Detail
-
getType
public String getType()
Description copied from interface:ScrollRequest
The type of Scroll.- Specified by:
getType
in interfaceScrollRequest
-
getName
public String getName()
Description copied from interface:ScrollRequest
The Scroll implementation name. Returnsnull
for default implementation.- Specified by:
getName
in interfaceScrollRequest
-
getSize
public int getSize()
Description copied from interface:ScrollRequest
The number of items to return per iteration.- Specified by:
getSize
in interfaceScrollRequest
-
getTimeout
public Duration getTimeout()
-
getUsername
public String getUsername()
-
getRepository
public String getRepository()
-
builder
public static DocumentScrollRequest.Builder builder(String nxqlQuery)
Creates a builder using an NXQL query.
-
-