com.unboundid.directory.sdk.common.operation
Interface UpdatableGenericResult

All Superinterfaces:

GenericResult, Result, UpdatableResult

All Known Subinterfaces:

UpdatableAddResult, UpdatableBindResult, UpdatableCompareResult, UpdatableDeleteResult, UpdatableExtendedResult, UpdatableModifyDNResult, UpdatableModifyResult, UpdatableSearchResult

@NotExtensible
@ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface UpdatableGenericResult
extends GenericResult, UpdatableResult

This interface defines a set of methods which may be used to update the contents of operation results.

Method Summary

void	setAdditionalLogMessage(java.lang.String message) Specifies 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.
void	setDiagnosticMessage(java.lang.String diagnosticMessage) Specifies the diagnostic message for the result, if any.
void	setMatchedDN(java.lang.String matchedDN) Specifies the matched DN for the result, if any.
void	setReferralURLs(java.util.List<java.lang.String> referralURLs) Specifies the referral URLs for the result.
void	setResultCode(ResultCode resultCode) Specifies the result code for the result.
void	setResultData(LDAPException le) Sets the contents of this result with information from the provided LDAP exception, including the result code, diagnostic message, matched DN, referral URLs, and controls.
void	setResultData(LDAPResult result) Sets the contents of this result with information from the provided LDAP result, including the result code, diagnostic message, matched DN, referral URLs, and controls.

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

getAdditionalLogMessage, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, toLDAPSDKResult

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

addResultControl, setResultControls

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

getOperationType, getResultControls

Method Detail

setResultCode

void setResultCode(ResultCode resultCode)

Specifies the result code for the result.

Parameters:

resultCode - The result code for the result. It must not be null.

setMatchedDN

void setMatchedDN(java.lang.String matchedDN)
                  throws LDAPException

Specifies the matched DN for the result, if any.

Parameters:

matchedDN - The matched DN for the result. It may be null if there is none.

Throws:

LDAPException - If the provided DN cannot be parsed.

setDiagnosticMessage

void setDiagnosticMessage(java.lang.String diagnosticMessage)

Specifies the diagnostic message for the result, if any.

Parameters:

diagnosticMessage - The diagnostic message for the result. It may be null if there is none.

setReferralURLs

void setReferralURLs(java.util.List<java.lang.String> referralURLs)

Specifies the referral URLs for the result.

Parameters:

referralURLs - The referral URLs for the result. It may be null or empty if there are none.

setAdditionalLogMessage

void setAdditionalLogMessage(java.lang.String message)

Specifies 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.

Parameters:

message - An additional log message for the result.

setResultData

void setResultData(LDAPResult result)

Sets the contents of this result with information from the provided LDAP result, including the result code, diagnostic message, matched DN, referral URLs, and controls.

Parameters:

result - The result to use to update this result. It must not be null.

setResultData

void setResultData(LDAPException le)

Sets the contents of this result with information from the provided LDAP exception, including the result code, diagnostic message, matched DN, referral URLs, and controls.

Parameters:

le - The exception to use to update this result. It must not be null.