Interface SearchCursor
-
- All Known Implementing Classes:
SearchCursorImpl
public interface SearchCursor extends Cursor<Response>
An extension of Cursor which includes the retrieval of the SearchResultDone.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Entry
getEntry()
IntermediateResponse
getIntermediate()
Referral
getReferral()
SearchResultDone
getSearchResultDone()
gives the SearchResultDone message received at the end of search resultsboolean
isDone()
boolean
isEntry()
boolean
isIntermediate()
boolean
isReferral()
-
Methods inherited from interface org.apache.directory.api.ldap.model.cursor.Cursor
after, afterLast, available, before, beforeFirst, close, first, get, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, last, next, previous, setClosureMonitor, toString
-
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
-
-
-
Method Detail
-
isDone
boolean isDone()
- Returns:
- true if the cursor has processed all the elements we were searching
-
getSearchResultDone
SearchResultDone getSearchResultDone()
gives the SearchResultDone message received at the end of search results- Returns:
- the SearchResultDone message, null if the search operation fails for any reason
-
isReferral
boolean isReferral()
- Returns:
- true if the next element in the cursor is a referral
-
getReferral
Referral getReferral() throws LdapException
- Returns:
- The next referral element, if it's a referral
- Throws:
LdapException
- If the
-
isEntry
boolean isEntry()
- Returns:
- true if the next element in the cursor is an entry
-
getEntry
Entry getEntry() throws LdapException
- Returns:
- The next entry element, if it's an entry
- Throws:
LdapException
- If the
-
isIntermediate
boolean isIntermediate()
- Returns:
- true if the next element in the cursor is an intermediate response
-
getIntermediate
IntermediateResponse getIntermediate() throws LdapException
- Returns:
- The next intermediate response element, if it's an intermediate response
- Throws:
LdapException
- If the
-
-