public interface InternalLdapResult
The LDAPResult is the construct used in this protocol to return success or failure indications from servers to clients. In response to various requests servers will return responses containing fields of type LDAPResult to indicate the final status of a protocol operation request.
Modifier and Type | Method and Description |
---|---|
String |
getErrorMessage()
Gets the descriptive error message associated with the error code.
|
DN |
getMatchedDn()
Gets the lowest entry in the directory that was matched.
|
InternalReferral |
getReferral()
Gets the Referral associated with this LdapResult if the resultCode
property is set to the REFERRAL ResultCodeEnum.
|
ResultCodeEnum |
getResultCode()
Gets the result code enumeration associated with the response.
|
boolean |
isReferral()
Gets whether or not this result represents a Referral.
|
void |
setErrorMessage(String errorMessage)
Sets the descriptive error message associated with the error code.
|
void |
setMatchedDn(DN dn)
Sets the lowest entry in the directory that was matched.
|
void |
setReferral(InternalReferral referral)
Sets the Referral associated with this LdapResult if the resultCode
property is set to the REFERRAL ResultCodeEnum.
|
void |
setResultCode(ResultCodeEnum resultCode)
Sets the result code enumeration associated with the response.
|
ResultCodeEnum getResultCode()
void setResultCode(ResultCodeEnum resultCode)
resultCode
- the result code enum value.DN getMatchedDn()
void setMatchedDn(DN dn)
dn
- the Dn of the lowest matched entry.getMatchedDn()
String getErrorMessage()
void setErrorMessage(String errorMessage)
errorMessage
- the descriptive error message.boolean isReferral()
InternalReferral getReferral()
void setReferral(InternalReferral referral)
referral
- optional referral on REFERRAL errors.Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.