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 TimestampSearch

All Known Implementing Classes:
  TimestampSearchImpl

    public interface TimestampSearch

LDAP Timestamp Search interface for LDAP servers not supporting Persistent Search control.

Version:
  $Revision: 1.3 $
Author:

Method Summary
`java.lang.String` | `getContextName()` Returns the context name set for this search operation
`STCEventQueue` | `getEventQueue()` Returns the event queue associated with this search operation
`int` | `getSearchScope()` Returns the search scope set for this search operation
`void` | `reset()` Method to reset the values
`void` | `search()` Initiates a search on the LDAP server.
`void` | `setContextName(java.lang.String contextName)` Sets the context name for this search operation
`void` | `setSearchScope(int searchScope)` Sets the search scope for this search operation

Method Detail

### getContextName

    java.lang.String getContextName()
                                    throws LDAPApplicationException

  Returns the context name set for this search operation

  Returns:
    the context name set for this search operation
  Throws:
    `LDAPApplicationException` - if no connection is available to the LDAP server

### setContextName

    void setContextName(java.lang.String contextName)
                        throws LDAPApplicationException

  Sets the context name for this search operation

  Parameters:
    `contextName` - the context name to be set for this search operation
  Throws:
    `LDAPApplicationException` - if no connection is available to the LDAP server

### getSearchScope

    int getSearchScope()
                       throws LDAPApplicationException

  Returns the search scope set for this search operation

  Returns:
    the search scope set for this search operation
  Throws:
    `LDAPApplicationException` - if no connection is available to the LDAP server

### setSearchScope

    void setSearchScope(int searchScope)
                        throws LDAPApplicationException

  Sets the search scope for this search operation

  Parameters:
    `searchScope` - the search scope to be set for this search operation
  Throws:
    `LDAPApplicationException` - if no connection is available to the LDAP server

### getEventQueue

    STCEventQueue getEventQueue()
                                throws LDAPApplicationException

  Returns the event queue associated with this search operation

  Returns:
    the event queue as a STCEventQueue object
  Throws:
    `LDAPApplicationException` - if no connection is available to the LDAP server

### search

    void search()
                throws LDAPApplicationException

  Initiates a search on the LDAP server.

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

### 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