SearchLdapOperation

java.lang.Object
- oracle.ldap.ospf.LdapOperation
- - oracle.ldap.ospf.SearchLdapOperation

```
public final class SearchLdapOperation
extends LdapOperation
```
Defines operation specific LDAP information that needs to pass between the Oracle directory server and the Java plug-in. Contains the following information:
- Bind DN
- Filter
- Required Attributes
- Scope
- Server Controls
- SearchResultSet (Valid only if the plug-in creates it)
- Operation Result Code
The WHEN_REPLACE plug-in can return the SearchLdapOperation object with the class's static fields as LDAP result codes. These LDAP result codes are ignored when returned with an SearchLdapOperation object from the PRE, WHEN or POST plug-ins.
Since:

10g Release 3 (10.1.4)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GSL_ACCOUNTLOCKED_EXCP` Account is Locked result code
`static int`	`GSL_ACCTDISABLED_EXCP` Account has been disabled result code
`static int`	`GSL_PWDEXPIRED_EXCP` Password Expired result code
`static int`	`LDAP_CONSTRAINT_VIOLATION` LDAP Constraint Violation result code
`static int`	`LDAP_FILTER_ERROR` LDAP Filter Error result code
`static int`	`LDAP_INSUFFICIENT_ACCESS` LDAP Insufficient Access result code
`static int`	`LDAP_INVALID_DN_SYNTAX` LDAP Invalid DN Syntax result code
`static int`	`LDAP_LOOP_DETECT` LDAP Loop Detect Error result code
`static int`	`LDAP_NO_MEMORY` LDAP No Memory result code
`static int`	`LDAP_NO_SUCH_OBJECT` LDAP No Such Object result code
`static int`	`LDAP_OBJECT_CLASS_VIOLATION` LDAP Object Class Violation result code
`static int`	`LDAP_PROTOCOL_ERROR` LDAP Protocol Error result code
`static int`	`LDAP_REFERRAL` LDAP Referral result code
`static int`	`LDAP_SCOPE_BASE` Base Level search scope
`static int`	`LDAP_SCOPE_ONELEVEL` One Level search scope
`static int`	`LDAP_SCOPE_SUBTREE` Subtree Level search scope
`static int`	`LDAP_SIZELIMIT_EXCEEDED` LDAP Sizelimit Exceeded result code
`static int`	`LDAP_TIMELIMIT_EXCEEDED` LDAP Timelimit Exceeded result code
`static int`	`LDAP_UNAVAILABLE_CRITICALEXTENSION` LDAP Unavailable CriticalExtension result code
`static int`	`LDAP_UNDEFINED_TYPE` LDAP Undefined Type result code
`static int`	`LDAP_USER_CANCELLED` LDAP User Cancelled result code

Fields inherited from class oracle.ldap.ospf.LdapOperation
LDAP_SUCCESS

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Vector`	`getRequiredAttributes()` Gets a copy of the required attributes from the SearchLdapOperation object.
`java.lang.String`	`getSearchFilter()` Gets the search filter from the SearchLdapOperation object
`int`	`getSearchScope()` Gets the search scope from the SearchLdapOperation object
`void`	`setRequiredAttributes(java.util.Vector reqdAttrs)` Sets the required attributes in the SearchLdapOperation object.
`void`	`setSearchResultSet(SearchResultSet srchResultSet)` Sets the SearchResultSet in the SearchLdapOperation object.
`void`	`setSearchScope(int srchScope)` Sets the search scope in the SearchLdapOperation object

Methods inherited from class oracle.ldap.ospf.LdapOperation
getBindDN, getOperationResultCode, getServerControls, setOperationResultCode

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LDAP_SCOPE_BASE
```
public static final int LDAP_SCOPE_BASE
```
    Base Level search scope
    
    See Also:
    
    Constant Field Values
  - LDAP_SCOPE_ONELEVEL
```
public static final int LDAP_SCOPE_ONELEVEL
```
    One Level search scope
    
    See Also:
    
    Constant Field Values
  - LDAP_SCOPE_SUBTREE
```
public static final int LDAP_SCOPE_SUBTREE
```
    Subtree Level search scope
    
    See Also:
    
    Constant Field Values
  - LDAP_PROTOCOL_ERROR
```
public static final int LDAP_PROTOCOL_ERROR
```
    LDAP Protocol Error result code
    
    See Also:
    
    Constant Field Values
  - LDAP_TIMELIMIT_EXCEEDED
```
public static final int LDAP_TIMELIMIT_EXCEEDED
```
    LDAP Timelimit Exceeded result code
    
    See Also:
    
    Constant Field Values
  - LDAP_SIZELIMIT_EXCEEDED
```
public static final int LDAP_SIZELIMIT_EXCEEDED
```
    LDAP Sizelimit Exceeded result code
    
    See Also:
    
    Constant Field Values
  - LDAP_REFERRAL
```
public static final int LDAP_REFERRAL
```
    LDAP Referral result code
    
    See Also:
    
    Constant Field Values
  - LDAP_UNAVAILABLE_CRITICALEXTENSION
```
public static final int LDAP_UNAVAILABLE_CRITICALEXTENSION
```
    LDAP Unavailable CriticalExtension result code
    
    See Also:
    
    Constant Field Values
  - LDAP_UNDEFINED_TYPE
```
public static final int LDAP_UNDEFINED_TYPE
```
    LDAP Undefined Type result code
    
    See Also:
    
    Constant Field Values
  - LDAP_CONSTRAINT_VIOLATION
```
public static final int LDAP_CONSTRAINT_VIOLATION
```
    LDAP Constraint Violation result code
    
    See Also:
    
    Constant Field Values
  - LDAP_NO_SUCH_OBJECT
```
public static final int LDAP_NO_SUCH_OBJECT
```
    LDAP No Such Object result code
    
    See Also:
    
    Constant Field Values
  - LDAP_INVALID_DN_SYNTAX
```
public static final int LDAP_INVALID_DN_SYNTAX
```
    LDAP Invalid DN Syntax result code
    
    See Also:
    
    Constant Field Values
  - LDAP_INSUFFICIENT_ACCESS
```
public static final int LDAP_INSUFFICIENT_ACCESS
```
    LDAP Insufficient Access result code
    
    See Also:
    
    Constant Field Values
  - LDAP_LOOP_DETECT
```
public static final int LDAP_LOOP_DETECT
```
    LDAP Loop Detect Error result code
    
    See Also:
    
    Constant Field Values
  - LDAP_OBJECT_CLASS_VIOLATION
```
public static final int LDAP_OBJECT_CLASS_VIOLATION
```
    LDAP Object Class Violation result code
    
    See Also:
    
    Constant Field Values
  - LDAP_FILTER_ERROR
```
public static final int LDAP_FILTER_ERROR
```
    LDAP Filter Error result code
    
    See Also:
    
    Constant Field Values
  - LDAP_USER_CANCELLED
```
public static final int LDAP_USER_CANCELLED
```
    LDAP User Cancelled result code
    
    See Also:
    
    Constant Field Values
  - LDAP_NO_MEMORY
```
public static final int LDAP_NO_MEMORY
```
    LDAP No Memory result code
    
    See Also:
    
    Constant Field Values
  - GSL_PWDEXPIRED_EXCP
```
public static final int GSL_PWDEXPIRED_EXCP
```
    Password Expired result code
    
    See Also:
    
    Constant Field Values
  - GSL_ACCOUNTLOCKED_EXCP
```
public static final int GSL_ACCOUNTLOCKED_EXCP
```
    Account is Locked result code
    
    See Also:
    
    Constant Field Values
  - GSL_ACCTDISABLED_EXCP
```
public static final int GSL_ACCTDISABLED_EXCP
```
    Account has been disabled result code
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSearchFilter
```
public java.lang.String getSearchFilter()
```
    Gets the search filter from the SearchLdapOperation object
    
    Returns:
    
    srchFilter - Search filter
  - setRequiredAttributes
```
public void setRequiredAttributes(java.util.Vector reqdAttrs)
```
    Sets the required attributes in the SearchLdapOperation object. Sets all attributes when passed a null. Causes no attributes to be returned in the search result. Sets no attributes when passed an empty vector. Causes no attributes to be returned in the search result.
    
    Parameters:
    
    reqdAttrs - - Required attributes
  - getRequiredAttributes
```
public java.util.Vector getRequiredAttributes()
```
    Gets a copy of the required attributes from the SearchLdapOperation object. Returns null if no required attributes were specified during the search operation.
    
    Returns:
    
    reqdAttrs - Required attributes
  - setSearchScope
```
public void setSearchScope(int srchScope)
```
    Sets the search scope in the SearchLdapOperation object
    
    Parameters:
    
    srchScope - - Search scope
  - getSearchScope
```
public int getSearchScope()
```
    Gets the search scope from the SearchLdapOperation object
    
    Returns:
    
    srchScope - Search scope
  - setSearchResultSet
```
public void setSearchResultSet(SearchResultSet srchResultSet)
```
    Sets the SearchResultSet in the SearchLdapOperation object. If a null SearchResultSet is set, it will be ignored by the Oracle directory server.
    
    Parameters:
    
    srchResultSet - - SearchResultSet

Class SearchLdapOperation

Field Summary

Fields inherited from class oracle.ldap.ospf.LdapOperation

Method Summary

Methods inherited from class oracle.ldap.ospf.LdapOperation

Methods inherited from class java.lang.Object

Field Detail

LDAP_SCOPE_BASE

LDAP_SCOPE_ONELEVEL

LDAP_SCOPE_SUBTREE

LDAP_PROTOCOL_ERROR

LDAP_TIMELIMIT_EXCEEDED

LDAP_SIZELIMIT_EXCEEDED

LDAP_REFERRAL

LDAP_UNAVAILABLE_CRITICALEXTENSION

LDAP_UNDEFINED_TYPE

LDAP_CONSTRAINT_VIOLATION

LDAP_NO_SUCH_OBJECT

LDAP_INVALID_DN_SYNTAX

LDAP_INSUFFICIENT_ACCESS

LDAP_LOOP_DETECT

LDAP_OBJECT_CLASS_VIOLATION

LDAP_FILTER_ERROR

LDAP_USER_CANCELLED

LDAP_NO_MEMORY

GSL_PWDEXPIRED_EXCP

GSL_ACCOUNTLOCKED_EXCP

GSL_ACCTDISABLED_EXCP

Method Detail

getSearchFilter

setRequiredAttributes

getRequiredAttributes

setSearchScope

getSearchScope

setSearchResultSet