LDAP Classes
Implements Java LDAP

com.novell.ldap
Class LDAPSearchResults

java.lang.Object
  extended bycom.novell.ldap.LDAPSearchResults
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
DSMLSearchResults, SPMLSearchResults

public class LDAPSearchResults
extends java.lang.Object
implements java.io.Externalizable

An LDAPSearchResults object is returned from a synchronous search operation. It provides access to all results received during the operation (entries and exceptions).

Sample Code: Search.java

See Also:
LDAPConnection.search(java.lang.String, int, java.lang.String, java.lang.String[], boolean), Serialized Form

Constructor Summary
LDAPSearchResults()
          This constructor was added to support default Serialization
 
Method Summary
 int getCount()
          Returns a count of the items in the search result.
 LDAPControl[] getDeSerializedControls()
          Returns LDAP Server Controls after De-serialization
 java.util.Vector getDeSerializedEntries()
          Returns LDAP Entries after De-serialization
 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.
static java.lang.Object readDSML(java.io.InputStream input)
          This method is used to deserialize the DSML encoded representation of this class.
 void readExternal(java.io.ObjectInput in)
          Reads the serialized object from the underlying input stream.
 void writeExternal(java.io.ObjectOutput out)
          Writes the object state to a stream in XML format
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LDAPSearchResults

public LDAPSearchResults()
This constructor was added to support default Serialization

Method Detail

getCount

public int getCount()
Returns a count of the items in the search result.

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.

Returns:
The number of items received but not retrieved by the application

getResponseControls

public 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.

Returns:
The server controls returned with the search request, or null if none were returned.

hasMore

public boolean hasMore()
Reports if there are more search results.

Returns:
true if there are more search results.

next

public LDAPEntry next()
               throws LDAPException
Returns the next result as an LDAPEntry.

If automatic referral following is disabled or if a referral was not followed, next() will throw an LDAPReferralException when the referral is received.

Returns:
The next search result as an LDAPEntry.
Throws:
LDAPException - A general exception which includes an error message and an LDAP error code.
LDAPReferralException - A referral was received and not followed.

readDSML

public static java.lang.Object readDSML(java.io.InputStream input)
                                 throws java.io.IOException
This method is used to deserialize the DSML encoded representation of this class.

Parameters:
input - InputStream for the DSML formatted data.
Returns:
Deserialized form of this class.
Throws:
java.io.IOException - when serialization fails.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Writes the object state to a stream in XML format

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
out - The ObjectOutput stream where the Object in XML format is being written to
Throws:
java.io.IOException - - If I/O errors occur

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Reads the serialized object from the underlying input stream.

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
in - The ObjectInput stream where the Serialized Object is being read from
Throws:
java.io.IOException - - If I/O errors occur
java.lang.ClassNotFoundException - - If the class for an object being restored cannot be found.

getDeSerializedEntries

public java.util.Vector getDeSerializedEntries()
Returns LDAP Entries after De-serialization

Returns:
entries as Vector.

getDeSerializedControls

public LDAPControl[] getDeSerializedControls()
Returns LDAP Server Controls after De-serialization

Returns:
controls as Array.

LDAP Classes
Implements Java LDAP

Copyright 2002 Novell, Inc. All Rights Reserved.
Novell, Inc.
1800 South Novell Place
Provo, Ut 84606
Phone: (801) 861-5000