LDAPRequest (ldap-ratype API documentation)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

LDAPAddRequest, LDAPBindRequest, LDAPCompareRequest, LDAPDeleteRequest, LDAPModifyDNRequest, LDAPModifyRequest, LDAPSearchRequest
```
public interface LDAPRequest
extends Cloneable
```
A base interface for LDAP requests.

See Also:

LDAPAddRequest, LDAPBindRequest, LDAPCompareRequest, LDAPDeleteRequest, LDAPModifyRequest, LDAPModifyDNRequest, LDAPSearchRequest

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`LDAPRequest`	`clone()`	Creates and returns a copy of this request that may be modified without impacting this request.
`long`	`getQueryTimeout()`	Returns the maximum time, in milliseconds, to wait for a response from the server when processing this request.
`LDAPRequest`	`setQueryTimeout(long timeout)`	Sets the maximum time, in milliseconds, to wait for a response from the server when processing this request.

- Method Detail
  - clone
```
LDAPRequest clone()
```
    Creates and returns a copy of this request that may be modified without impacting this request.
    
    Returns:
    
    A copy this request that may be modified without impacting this request.
  - getQueryTimeout
```
long getQueryTimeout()
```
    Returns the maximum time, in milliseconds, to wait for a response from the server when processing this request.
    
    Returns:
    
    the maximum time, in milliseconds, to wait for a response from the server when processing this request.
  - setQueryTimeout
```
LDAPRequest setQueryTimeout(long timeout)
```
    Sets the maximum time, in milliseconds, to wait for a response from the server when processing this request.
    A value of zero indicates that no timeout should be enforced.
    A value that is less than zero indicates that the default query timeout for the underlying connection should be used.
    
    Parameters:
    
    timeout - the maximum time, in milliseconds, to wait for a response from the server when processing this request.
    
    Returns:
    
    this request.