Overview | Package | Class | Tree | Deprecated | Index | Help
| Sun Adapter for LDAP API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.stc.connector.appconn.ldap
Interface Search

All Known Implementing Classes:
  SearchImpl

    public interface Search

LDAP Search interface. This defines the methods for a search operation.

Version:
  $Revision: 1.3 $
Author:

Method Summary
`LDAPSearchControls` | `getLDAPSearchControls()` If using an LDAP provider, get the LDAPSearchControls object for the search controls option.
`SearchOptions` | `getSearchOptions()` Get the SearchOption object for the search options.
`SearchResults` | `getSearchResults()` Get the SearchResults object for the search results.
`void` | `performSearch()` Perform a directory search for entries in the directory that match the criteria previously defined.
`void` | `removeSearchControls()` Used to clear search controls from context if controls were added for search
`void` | `reset()` Method to reset the values
`void` | `searchCleanup()` Used to clean up the search results.

Method Detail

### getLDAPSearchControls

    LDAPSearchControls getLDAPSearchControls()
                                             throws LDAPApplicationException

  If using an LDAP provider, get the LDAPSearchControls object for the search controls option.

  Returns:
    The LDAP search options as a LDAPSearchControls object.
  Throws:
    `LDAPApplicationException`

### getSearchOptions

    SearchOptions getSearchOptions()
                                   throws LDAPApplicationException

  Get the SearchOption object for the search options.

  Returns:
    The search options as a SearchOptions object.
  Throws:
    `LDAPApplicationException`

### getSearchResults

    SearchResults getSearchResults()
                                   throws LDAPApplicationException

  Get the SearchResults object for the search results.

  Returns:
    The search results as a SearchResults object.
  Throws:
    `LDAPApplicationException`

### performSearch

    void performSearch()
                       throws LDAPApplicationException

  Perform a directory search for entries in the directory that match the criteria previously defined.

  Throws:
    `LDAPApplicationException` - upon error
  See Also:
    `SearchOptions`

### searchCleanup

    void searchCleanup()
                       throws LDAPApplicationException

  Used to clean up the search results.

  Throws:
    `LDAPApplicationException` - if connection to the LDAP server is not available.

### removeSearchControls

    void removeSearchControls()
                              throws LDAPApplicationException

  Used to clear search controls from context if controls were added for search

  Throws:
    `LDAPApplicationException` - if connection to the LDAP server is not available.

### reset

    void reset()

  Method to reset the values

Overview | Package | Class | Tree | Deprecated | Index | Help
| Sun Adapter for LDAP API
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD