|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.migrate.ldapjdk.LDAPSearchResults
@Mutable @NotExtensible @ThreadSafety(level=NOT_THREADSAFE) public class LDAPSearchResults
This class provides a data structure that provides access to data returned
in response to a search operation.
This class is primarily intended to be used in the process of updating
applications which use the Netscape Directory SDK for Java to switch to or
coexist with the UnboundID LDAP SDK for Java. For applications not written
using the Netscape Directory SDK for Java, the SearchResult
class
should be used instead.
Constructor Summary | |
---|---|
LDAPSearchResults()
Creates a new LDAP search results object. |
|
LDAPSearchResults(long maxWaitTime)
Creates a new LDAP search results object with the specified maximum wait time. |
Method Summary | |
---|---|
int |
getCount()
Retrieves the number of results that are available for immediate processing. |
LDAPControl[] |
getResponseControls()
Retrieves the response controls for the last result element returned, or for the search itself if the search has completed. |
boolean |
hasMoreElements()
Indicates whether there are any more search results to return. |
LDAPEntry |
next()
Retrieves the next entry from the set of search results. |
java.lang.Object |
nextElement()
Retrieves the next element in the set of search results. |
void |
searchEntryReturned(SearchResultEntry searchEntry)
Indicates that the provided search result entry has been returned by the server and may be processed by this search result listener. |
void |
searchReferenceReturned(SearchResultReference searchReference)
Indicates that the provided search result reference has been returned by the server and may be processed by this search result listener. |
void |
searchResultReceived(AsyncRequestID requestID,
SearchResult searchResult)
Indicates that the provided search result has been received in response to an asynchronous search operation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LDAPSearchResults()
public LDAPSearchResults(long maxWaitTime)
maxWaitTime
- The maximum wait time in milliseconds.Method Detail |
---|
public boolean hasMoreElements()
hasMoreElements
in interface java.util.Enumeration<java.lang.Object>
true
if there are more search results to return, or
false
if not.public java.lang.Object nextElement() throws java.util.NoSuchElementException
nextElement
in interface java.util.Enumeration<java.lang.Object>
java.util.NoSuchElementException
- If there are no more results.public LDAPEntry next() throws LDAPException
LDAPException
- If there are no more elements to return, or if
the next element in the set of results is not an
entry.public int getCount()
public LDAPControl[] getResponseControls()
null
if no elements have yet been returned or if the last
element did not include any controls.@InternalUseOnly public void searchEntryReturned(SearchResultEntry searchEntry)
searchEntryReturned
in interface SearchResultListener
searchEntry
- The search result entry that has been returned by the
server.@InternalUseOnly public void searchReferenceReturned(SearchResultReference searchReference)
searchReferenceReturned
in interface SearchResultListener
searchReference
- The search result reference that has been returned
by the server.@InternalUseOnly public void searchResultReceived(AsyncRequestID requestID, SearchResult searchResult)
searchResultReceived
in interface AsyncSearchResultListener
requestID
- The async request ID of the request for which the
response was received.searchResult
- The search result that has been received.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |