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

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name
protected final String	query
protected final String	reference
protected final String	repository
protected static final String	SCROLL_TYPE
protected final int	size
protected final Duration	timeout
protected final String	username

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocumentScrollRequest(DocumentScrollRequest.Builder builder)

Method Summary

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	getReference()	Gets a reference associated with the scroll request.
String	getRepository()
int	getSize()	The number of items to return per iteration.
Duration	getTimeout()
String	getType()	The type of Scroll.
String	getUsername()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

SCROLL_TYPE

protected static final String SCROLL_TYPE

See Also:

• Constant Field Values

name

protected final String name

query

protected final String query

repository

protected final String repository

timeout

protected final Duration timeout

size

protected final int size

username

protected final String username

reference

protected final String reference

Constructor Details

DocumentScrollRequest

protected DocumentScrollRequest(DocumentScrollRequest.Builder builder)

Method Details

getType

public String getType()

Description copied from interface: ScrollRequest

The type of Scroll.

Specified by:

getType in interface ScrollRequest

getName

public String getName()

Description copied from interface: ScrollRequest

The Scroll implementation name. Returns null for default implementation.

Specified by:

getName in interface ScrollRequest

getSize

public int getSize()

Description copied from interface: ScrollRequest

The number of items to return per iteration.

Specified by:

getSize in interface ScrollRequest

getReference

public String getReference()

Description copied from interface: ScrollRequest

Gets a reference associated with the scroll request.

Specified by:

getReference in interface ScrollRequest

getQuery

public String getQuery()

getTimeout

public Duration getTimeout()

getUsername

public String getUsername()

getRepository

public String getRepository()

toString

public String toString()

Overrides:

toString in class Object

builder

public static DocumentScrollRequest.Builder builder(String nxqlQuery)

Creates a builder using an NXQL query.