com.unboundid.directory.sdk.common.types

Interface CompletedSearchOperationContext

All Superinterfaces:

CompletedOperationContext, OperationContext

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface CompletedSearchOperationContext
extends CompletedOperationContext

This interface defines a set of methods that may be used to obtain information about a search operation for which processing has been completed.

Method Summary

Modifier and Type	Method and Description
long	getEntryCount() Retrieves the number of entries that were returned to the client during the course of the search.
long	getReferenceCount() Retrieves the number of references that were returned to the client during the course of the search.
boolean	isUnindexed() Indicates whether the search operation was considered unindexed.

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

getDequeueTime, getEnqueueTime, getMissingPrivilegeNames, getPreAuthorizationUsedPrivilegeNames, getProcessingEndTime, getProcessingStartTime, getProcessingTimeMillis, getProcessingTimeNanos, getQueueWaitTimeMillis, getResult, getUsedPrivilegeNames

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

addCustomLogElement, appendAdditionalLogMessage, deregisterOperationCompletedListener, getAttachment, getAuthorizationDN, getClientContext, getConnectionID, getCustomLogElements, getInternalRootConnection, getInternalRootConnection, getInternalUserConnection, getInternalUserConnection, getMessageID, getOperationID, getOperationType, getRequest, getServerContext, isAdministrativeOperation, isInternalOperation, isReplicationOperation, isSecure, registerOperationCompletedListener, setAttachment, toString

Method Detail

getEntryCount

long getEntryCount()

Retrieves the number of entries that were returned to the client during the course of the search.

Returns:

The number of entries that were returned to the client during the course of the search.

getReferenceCount

long getReferenceCount()

Retrieves the number of references that were returned to the client during the course of the search.

Returns:

The number of references that were returned to the client during the course of the search.

isUnindexed

boolean isUnindexed()

Indicates whether the search operation was considered unindexed.

Returns:

true if the search operation was considered unindexed, or false if not.