com.stc.connector.appconn.ldap
Interface SearchResults

All Known Implementing Classes:

SearchResultsImpl

public interface SearchResults

Search Results interface used to receive the results from a search operation.

Version:

$Revision: 1.5 $

Author:

Method Summary

void	clear() Close the underlying result object.
Result	getResult() Get the current result.
boolean	hasMoreResults() Check to see if any results were returned by the search.
boolean	hasResults() Check to see if any results were returned by the search.
boolean	nextResult() Get the next result returned by the search.
void	reset() Method to reset the values

Method Detail

getResult

Result getResult()
                 throws LDAPApplicationException

Get the current result.

Throws:

LDAPApplicationException - if there is no connection is available to the LDAP server.

See Also:

hasResults(), hasMoreResults(), #getNextResult

clear

void clear()
           throws LDAPApplicationException

Close the underlying result object.

Throws:

LDAPApplicationException - if there is no connection is available to the LDAP server.

hasResults

boolean hasResults()
                   throws LDAPApplicationException

Check to see if any results were returned by the search.

Throws:

LDAPApplicationException - if there is no connection is available to the LDAP server.

See Also:

SearchOptions, Search.performSearch(), #getNextResult

hasMoreResults

boolean hasMoreResults()
                       throws LDAPApplicationException

Check to see if any results were returned by the search.

Throws:

LDAPApplicationException - if there is no connection is available to the LDAP server.

See Also:

SearchOptions, Search.performSearch(), hasResults(), #getNextResult

nextResult

boolean nextResult()
                   throws LDAPApplicationException

Get the next result returned by the search. Populate the results for retrieval.

Throws:

LDAPApplicationException - if there is no connection is available to the LDAP server.

See Also:

SearchOptions, Search.performSearch(), hasResults()

reset

void reset()

Method to reset the values