com.unboundid.ldap.sdk.unboundidds.monitors
Class OperationResultCodeInfo

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.OperationResultCodeInfo
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class OperationResultCodeInfo
extends java.lang.Object
implements java.io.Serializable

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 class provides a data structure that provides information about the result codes associated with a particular type of operation (or across all types of operations, if the associated operation type is null).

See Also:
Serialized Form

Method Summary
 java.lang.Long getFailedCount()
          Retrieves the number of operations of the associated type that resulted in failure, if available.
 java.lang.Double getFailedPercent()
          Retrieves the percent of operations of the associated type that resulted in failure, if available.
 OperationType getOperationType()
          Retrieves the type of operation with which this result code information is associated, if appropriate.
 java.util.Map<java.lang.Integer,ResultCodeInfo> getResultCodeInfoMap()
          Retrieves a map with information about the result codes that have been returned for operations of the associated type, indexed by the result code's integer value.
 java.lang.Long getTotalCount()
          Retrieves the total number of operations of the associated type that have been processed, if available.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getOperationType

public OperationType getOperationType()
Retrieves the type of operation with which this result code information is associated, if appropriate.

Returns:
The type of operation with which this result code information is associated, or null if this information applies to all types of operations.

getTotalCount

public java.lang.Long getTotalCount()
Retrieves the total number of operations of the associated type that have been processed, if available.

Returns:
The total number of operations of the associated type that have been processed, or null if this information was not in the monitor entry.

getFailedCount

public java.lang.Long getFailedCount()
Retrieves the number of operations of the associated type that resulted in failure, if available.

Returns:
The number of operations of the associated type that resulted in failure, or null if this information was not in the monitor entry.

getFailedPercent

public java.lang.Double getFailedPercent()
Retrieves the percent of operations of the associated type that resulted in failure, if available.

Returns:
The percent of operations of the associated type that resulted in failure, or null if this information was not in the monitor entry.

getResultCodeInfoMap

public java.util.Map<java.lang.Integer,ResultCodeInfo> getResultCodeInfoMap()
Retrieves a map with information about the result codes that have been returned for operations of the associated type, indexed by the result code's integer value.

Returns:
A map with information about the result codes that have been returned for operations of the associated type.