Package org.nuxeo.ecm.core.scroll

Class GenericScrollRequest

java.lang.Object

org.nuxeo.ecm.core.scroll.GenericScrollRequest

All Implemented Interfaces:

ScrollRequest

public class GenericScrollRequest
extends Object
implements ScrollRequest

Generic Scroll Request.

Since:

11.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericScrollRequest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Serializable>	options
protected final String	query
protected final String	reference
static final String	SCROLL_TYPE
protected final String	scrollName
protected final int	size

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericScrollRequest(GenericScrollRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static GenericScrollRequest.Builder	builder(String scrollName, String query)
String	getName()	The Scroll implementation name.
Map<String,Serializable>	getOptions()
String	getQuery()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SCROLL_TYPE

public static final String SCROLL_TYPE

See Also:

• Constant Field Values

size

protected final int size

reference

protected final String reference

query

protected final String query

scrollName

protected final String scrollName

options

protected final Map<String,Serializable> options

Constructor Details

GenericScrollRequest

protected GenericScrollRequest(GenericScrollRequest.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()

getOptions

public Map<String,Serializable> getOptions()

builder

public static GenericScrollRequest.Builder builder(String scrollName,
 String query)

toString

public String toString()

Overrides:

toString in class Object