com.unboundid.directory.sdk.common.types
Interface ActiveSearchOperationContext

All Superinterfaces:

ActiveOperationContext, OperationContext

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface ActiveSearchOperationContext
extends ActiveOperationContext

This interface defines a set of methods that may be used to obtain information about a search operation that is actively being processed and for which the final response has not yet been sent.

Method Summary

void	sendSearchEntry(com.unboundid.ldap.sdk.SearchResultEntry e) Attempts to send a search result entry to the client.
void	sendSearchReference(com.unboundid.ldap.sdk.SearchResultReference r) Attempts to send a search result reference to the client.

Methods inherited from interface com.unboundid.directory.sdk.common.types.ActiveOperationContext

sendIntermediateResponse, setAttachment

Methods inherited from interface com.unboundid.directory.sdk.common.types.OperationContext

getAttachment, getAuthorizationDN, getClientContext, getConnectionID, getInternalRootConnection, getInternalRootConnection, getInternalUserConnection, getInternalUserConnection, getMessageID, getOperationID, getOperationType, getRequest, getServerContext, isInternalOperation, isReplicationOperation, isSecure, toString

Method Detail

sendSearchEntry

void sendSearchEntry(com.unboundid.ldap.sdk.SearchResultEntry e)
                     throws com.unboundid.ldap.sdk.LDAPException

Attempts to send a search result entry to the client.

Parameters:

e - The entry to be returned to the client.

Throws:

com.unboundid.ldap.sdk.LDAPException - If a problem occurs while attempting to send the entry and processing on the associated operation should be aborted.

sendSearchReference

void sendSearchReference(com.unboundid.ldap.sdk.SearchResultReference r)
                         throws com.unboundid.ldap.sdk.LDAPException

Attempts to send a search result reference to the client.

Parameters:

r - The reference to be returned to the client.

Throws:

com.unboundid.ldap.sdk.LDAPException - If a problem occurs while attempting to send the reference and processing on the associated operation should be aborted.