|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.ldap.LDAPSearchResults
com.novell.ldap.DSMLSearchResults
public class DSMLSearchResults
Field Summary | |
---|---|
(package private) LDAPControl[] |
controls
The returned controls |
(package private) boolean |
empty
Are there no results? |
(package private) LDAPMessage |
lastread
The last read message |
(package private) int |
msgRespPtr
The response pointer |
private LDAPReader |
reader
The Reader |
(package private) boolean |
wasRead
Have any results been read? |
Constructor Summary | |
---|---|
DSMLSearchResults()
|
|
DSMLSearchResults(LDAPReader reader)
|
Method Summary | |
---|---|
(package private) void |
abandon()
Cancels the search request and clears the message and enumeration. |
int |
getCount()
Returns a count of the items in the search result. |
LDAPControl[] |
getResponseControls()
Returns the latest server controls returned by the server in the context of this search request, or null if no server controls were returned. |
boolean |
hasMore()
Reports if there are more search results. |
LDAPEntry |
next()
Returns the next result as an LDAPEntry. |
Methods inherited from class com.novell.ldap.LDAPSearchResults |
---|
getDeSerializedControls, getDeSerializedEntries, getXMLControlHandler, getXMLEntryHandler, readDSML, readExternal, writeExternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
LDAPControl[] controls
int msgRespPtr
private LDAPReader reader
LDAPMessage lastread
boolean empty
boolean wasRead
Constructor Detail |
---|
public DSMLSearchResults(LDAPReader reader)
public DSMLSearchResults()
Method Detail |
---|
void abandon()
LDAPSearchResults
abandon
in class LDAPSearchResults
public int getCount()
LDAPSearchResults
Returns a count of the entries and exceptions remaining in the object. If the search was submitted with a batch size greater than zero, getCount reports the number of results received so far but not enumerated with next(). The behavior is same for search submitted with batch size equals to 0.
For blocking calls with batch size equals to 0, get count returns the count of all the expected results from search for first time once after enumerated with hasMore(). The subsequent iterations decrement count value for both blocking and non-blocking calls.
getCount
in class LDAPSearchResults
public LDAPControl[] getResponseControls()
LDAPSearchResults
getResponseControls
in class LDAPSearchResults
public boolean hasMore()
LDAPSearchResults
hasMore
in class LDAPSearchResults
public LDAPEntry next() throws LDAPException
LDAPSearchResults
If automatic referral following is disabled or if a referral was not followed, next() will throw an LDAPReferralException when the referral is received.
next
in class LDAPSearchResults
LDAPException
- A general exception which includes an error
message and an LDAP error code.
LDAPReferralException
- A referral was received and not
followed.
|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |