com.unboundid.directory.sdk.common.operation

Interface GenericResult

All Superinterfaces:

Result

All Known Subinterfaces:

AddResult, BindResult, CompareResult, DeleteResult, ExtendedResult, ModifyDNResult, ModifyResult, SearchResult, UpdatableAddResult, UpdatableBindResult, UpdatableCompareResult, UpdatableDeleteResult, UpdatableExtendedResult, UpdatableGenericResult, UpdatableModifyDNResult, UpdatableModifyResult, UpdatableSearchResult

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface GenericResult
extends Result

This interface defines a set of methods which may be used to interact with properties common to most types of LDAP results.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalLogMessage() Retrieves an additional log message for the result which will not be returned to the client but may be included in access log messages for the associated operation.
java.lang.String	getDiagnosticMessage() Retrieves the diagnostic message for the result, if any.
java.lang.String	getMatchedDN() Retrieves the matched DN for the result, if any.
java.util.List<java.lang.String>	getReferralURLs() Retrieves the referral URLs for the result.
com.unboundid.ldap.sdk.ResultCode	getResultCode() Retrieves the result code for the result.
com.unboundid.ldap.sdk.LDAPResult	toLDAPSDKResult() Retrieves an LDAP SDK representation of this result.

Methods inherited from interface com.unboundid.directory.sdk.common.operation.Result

getOperationType, getResultControls

Method Detail

getResultCode

com.unboundid.ldap.sdk.ResultCode getResultCode()

Retrieves the result code for the result.

Returns:

The result code for the result.

getMatchedDN

java.lang.String getMatchedDN()

Retrieves the matched DN for the result, if any.

Returns:

The matched DN for the result, or null if there is none.

getDiagnosticMessage

java.lang.String getDiagnosticMessage()

Retrieves the diagnostic message for the result, if any.

Returns:

The diagnostic message for the result, or null if there is none.

getReferralURLs

java.util.List<java.lang.String> getReferralURLs()

Retrieves the referral URLs for the result.

Returns:

The referral URLs for the result, or an empty list if there are none.

getAdditionalLogMessage

java.lang.String getAdditionalLogMessage()

Retrieves an additional log message for the result which will not be returned to the client but may be included in access log messages for the associated operation.

Returns:

An additional log message for the result.

toLDAPSDKResult

com.unboundid.ldap.sdk.LDAPResult toLDAPSDKResult()

Retrieves an LDAP SDK representation of this result.

Returns:

An LDAP SDK representation of this result.