Package org.nuxeo.ecm.core.query.scroll

Class QueryBuilderScrollRequest

java.lang.Object

org.nuxeo.ecm.core.query.scroll.QueryBuilderScrollRequest

All Implemented Interfaces:

ScrollRequest

public class QueryBuilderScrollRequest
extends Object
implements ScrollRequest

Since:

2025.18

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryBuilderScrollRequest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	froms
protected final String	name
protected final QueryBuilder	queryBuilder
protected final String	reference
protected static final String	SCROLL_TYPE
protected final int	size
protected final Duration	timeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryBuilderScrollRequest(QueryBuilderScrollRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static QueryBuilderScrollRequest.Builder	builder(String name, String query)
List<String>	getFroms()
String	getName()	The Scroll implementation name.
QueryBuilder	getQueryBuilder()
String	getReference()	Gets a reference associated with the scroll request.
int	getSize()	The number of items to return per iteration.
Duration	getTimeout()
String	getType()	The type of Scroll.

Methods inherited from class java.lang.Object

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

Field Details

SCROLL_TYPE

protected static final String SCROLL_TYPE

See Also:

• Constant Field Values

name

protected final String name

queryBuilder

protected final QueryBuilder queryBuilder

froms

protected final List<String> froms

size

protected final int size

timeout

protected final Duration timeout

reference

protected final String reference

Constructor Details

QueryBuilderScrollRequest

protected QueryBuilderScrollRequest(QueryBuilderScrollRequest.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

getQueryBuilder

public QueryBuilder getQueryBuilder()

getFroms

public List<String> getFroms()

getSize

public int getSize()

Description copied from interface: ScrollRequest

The number of items to return per iteration.

Specified by:

getSize in interface ScrollRequest

getTimeout

public Duration getTimeout()

getReference

public String getReference()

Description copied from interface: ScrollRequest

Gets a reference associated with the scroll request.

Specified by:

getReference in interface ScrollRequest

builder

public static QueryBuilderScrollRequest.Builder builder(String name,
 String query)