Interface ExtendedResult

All Superinterfaces:

ProtocolOp, Response, Result

All Known Implementing Classes:

GenericExtendedResult, PasswordModifyExtendedResult, RegistrationToCoreExtendedResult, StartTlsExtendedResult, WhoAmIExtendedResult

public interface ExtendedResult
extends Result

An Extended result indicates the status of an Extended operation and any additional information associated with the Extended operation, including the optional response name and value. These can be retrieved using the oid() and value() methods respectively.

Method Summary

Modifier and Type	Method	Description
boolean	hasValue()	Returns true if this extended result has a value.
String	oid()	Returns the numeric OID, if any, associated with this extended result.
ByteString	value()	Returns the value, if any, associated with this extended result.

Methods inherited from interface ProtocolOp

addControl, addControls, containsControl, controls, getControl, getControl, removeControls

Methods inherited from interface Result

cause, diagnosticMessage, diagnosticMessageAsString, isReferral, isSuccess, matchedDn, referralUris, resultCode

Method Details

oid

String oid()

Returns the numeric OID, if any, associated with this extended result.

Returns:

The numeric OID associated with this extended result, or null if there is no OID.

value

ByteString value()

Returns the value, if any, associated with this extended result. Its format is defined by the specification of this extended result.

Returns:

The value associated with this extended result, or null if there is no value.

hasValue

boolean hasValue()

Returns true if this extended result has a value. In some circumstances it may be useful to determine if an extended result has a value, without actually calculating the value and incurring any performance costs.

Returns:

true if this extended result has a value, or false if there is no value.