Package org.nuxeo.ecm.core.scroll

Class StaticScrollRequest

java.lang.Object

org.nuxeo.ecm.core.scroll.StaticScrollRequest

All Implemented Interfaces:

ScrollRequest

public class StaticScrollRequest
extends Object
implements ScrollRequest

Scroll Request for a static result set.

Since:

11.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StaticScrollRequest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	identifiers
protected static final String	SCROLL_NAME
protected static final String	SCROLL_TYPE
protected final int	size

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StaticScrollRequest(StaticScrollRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static StaticScrollRequest.Builder	builder(String singleIdentifier)
static StaticScrollRequest.Builder	builder(List<String> identifiers)
List<String>	getIdentifiers()
String	getName()	The Scroll implementation name.
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

Methods inherited from interface org.nuxeo.ecm.core.api.scroll.ScrollRequest

getReference

Field Details

SCROLL_TYPE

protected static final String SCROLL_TYPE

See Also:

• Constant Field Values

SCROLL_NAME

protected static final String SCROLL_NAME

See Also:

• Constant Field Values

size

protected final int size

identifiers

protected final List<String> identifiers

Constructor Details

StaticScrollRequest

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

getIdentifiers

public List<String> getIdentifiers()

builder

public static StaticScrollRequest.Builder builder(String singleIdentifier)

builder

public static StaticScrollRequest.Builder builder(List<String> identifiers)

toString

public String toString()

Overrides:

toString in class Object