com.unboundid.ldap.sdk.unboundidds.logs
Interface MinimalOperationResultAccessLogMessage

All Known Subinterfaces:
OperationResultAccessLogMessage
All Known Implementing Classes:
AbandonResultAccessLogMessage, AddAssuranceCompletedAccessLogMessage, AddResultAccessLogMessage, BindResultAccessLogMessage, CompareResultAccessLogMessage, DeleteAssuranceCompletedAccessLogMessage, DeleteResultAccessLogMessage, ExtendedResultAccessLogMessage, ModifyAssuranceCompletedAccessLogMessage, ModifyDNAssuranceCompletedAccessLogMessage, ModifyDNResultAccessLogMessage, ModifyResultAccessLogMessage, SearchResultAccessLogMessage

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface MinimalOperationResultAccessLogMessage

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This interface defines a number of methods common to all types of operation result access log messages.


Method Summary
 java.lang.String getAdditionalInformation()
          Retrieves a message with additional information about the result of the operation.
 java.lang.String getDiagnosticMessage()
          Retrieves the diagnostic message for the operation.
 java.lang.String getMatchedDN()
          Retrieves the matched DN for the operation.
 java.lang.Double getProcessingTimeMillis()
          Retrieves the length of time in milliseconds required to process the operation.
 java.lang.Double getQueueTimeMillis()
          Retrieves the length of time in milliseconds the operation was required to wait on the work queue.
 java.util.List<java.lang.String> getReferralURLs()
          Retrieves the list of referral URLs for the operation.
 ResultCode getResultCode()
          Retrieves the result code for the operation.
 

Method Detail

getResultCode

ResultCode getResultCode()
Retrieves the result code for the operation.

Returns:
The result code for the operation, or null if it is not included in the log message.

getDiagnosticMessage

java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for the operation.

Returns:
The diagnostic message for the operation, or null if it is not included in the log message.

getAdditionalInformation

java.lang.String getAdditionalInformation()
Retrieves a message with additional information about the result of the operation.

Returns:
A message with additional information about the result of the operation, or null if it is not included in the log message.

getMatchedDN

java.lang.String getMatchedDN()
Retrieves the matched DN for the operation.

Returns:
The matched DN for the operation, or null if it is not included in the log message.

getReferralURLs

java.util.List<java.lang.String> getReferralURLs()
Retrieves the list of referral URLs for the operation.

Returns:
The list of referral URLs for the operation, or an empty list if it is not included in the log message.

getProcessingTimeMillis

java.lang.Double getProcessingTimeMillis()
Retrieves the length of time in milliseconds required to process the operation.

Returns:
The length of time in milliseconds required to process the operation, or null if it is not included in the log message.

getQueueTimeMillis

java.lang.Double getQueueTimeMillis()
Retrieves the length of time in milliseconds the operation was required to wait on the work queue.

Returns:
The length of time in milliseconds the operation was required to wait on the work queue, or null if it is not included in the log message.