Package org.nuxeo.ecm.directory.scroll

Class DirectoryScroll

java.lang.Object

org.nuxeo.ecm.directory.scroll.DirectoryScroll

All Implemented Interfaces:

AutoCloseable, Iterator<List<String>>, Scroll

public class DirectoryScroll
extends Object
implements Scroll

Scrolls directory entry ids.

The scroll query is expressed in NXQL e.g "SELECT * FROM continent". Where clauses are ignored and results are ordered by directory id field ascendant.

Since:

2025.1

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	hasNext
protected NuxeoLoginContext	loginContext
protected long	offset
protected OrderByExpr	orderBy
static final String	SCROLL_NAME
protected Session	session
protected int	size

Constructor Summary

Constructors

Constructor	Description
DirectoryScroll()

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasNext()
void	init(ScrollRequest request, Map<String,String> options)	Initialization of the iterator.
List<String>	next()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Field Details

SCROLL_NAME

public static final String SCROLL_NAME

See Also:

• Constant Field Values

loginContext

protected NuxeoLoginContext loginContext

session

protected Session session

offset

protected long offset

size

protected int size

hasNext

protected boolean hasNext

orderBy

protected OrderByExpr orderBy

Constructor Details

DirectoryScroll

public DirectoryScroll()

Method Details

init

public void init(ScrollRequest request,
 Map<String,String> options)

Description copied from interface: Scroll

Initialization of the iterator.

Specified by:

init in interface Scroll

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Scroll

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<List<String>>

next

public List<String> next()

Specified by:

next in interface Iterator<List<String>>