com.unboundid.ldap.sdk.unboundidds.extensions
Class MultiUpdateExtendedResult

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPResult
      extended by com.unboundid.ldap.sdk.ExtendedResult
          extended by com.unboundid.ldap.sdk.unboundidds.extensions.MultiUpdateExtendedResult
All Implemented Interfaces:
LDAPResponse, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class MultiUpdateExtendedResult
extends ExtendedResult

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 an implementation of an extended result that can be used to provide information about the processing for a MultiUpdateExtendedRequest. The OID for this result is 1.3.6.1.4.1.30221.2.6.18, and the value (if present) should have the following encoding:

   MultiUpdateResultValue ::= SEQUENCE {
        changesApplied     ENUMERATED {
             none        (0),
             all         (1),
             partial     (2),
             ... },
        responses     SEQUENCE OF SEQUENCE {
             responseOp     CHOICE {
                  modifyResponse     ModifyResponse,
                  addResponse        AddResponse,
                  delResponse        DelResponse,
                  modDNResponse      ModifyDNResponse,
                  extendedResp       ExtendedResponse,
                  ... },
             controls       [0] Controls OPTIONAL,
             ... },
        }
 

See Also:
MultiUpdateChangesApplied, MultiUpdateExtendedRequest, Serialized Form

Field Summary
static java.lang.String MULTI_UPDATE_RESULT_OID
          The OID (1.3.6.1.4.1.30221.2.6.18) for the multi-update extended result.
 
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
 
Constructor Summary
MultiUpdateExtendedResult(ExtendedResult extendedResult)
          Creates a new multi-update extended result from the provided extended result.
MultiUpdateExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, MultiUpdateChangesApplied changesApplied, java.util.List<ObjectPair<OperationType,LDAPResult>> results, Control... controls)
          Creates a new multi-update extended request with the provided information.
 
Method Summary
 MultiUpdateChangesApplied getChangesApplied()
          Retrieves the value that indicates whether any or all changes from the multi-update request were successfully applied.
 java.lang.String getExtendedResultName()
          Retrieves the user-friendly name for the extended result, if available.
 java.util.List<ObjectPair<OperationType,LDAPResult>> getResults()
          Retrieves a list of the results for operations processed as part of the multi-update operation, with each result paired with its corresponding operation type.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this extended result to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult
getOID, getValue, hasValue, toString
 
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MULTI_UPDATE_RESULT_OID

public static final java.lang.String MULTI_UPDATE_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.18) for the multi-update extended result.

See Also:
Constant Field Values
Constructor Detail

MultiUpdateExtendedResult

public MultiUpdateExtendedResult(ExtendedResult extendedResult)
                          throws LDAPException
Creates a new multi-update extended result from the provided extended result.

Parameters:
extendedResult - The extended result to be decoded as a multi-update result.
Throws:
LDAPException - If a problem is encountered while attempting to decode the provided extended result as a multi-update result.

MultiUpdateExtendedResult

public MultiUpdateExtendedResult(int messageID,
                                 ResultCode resultCode,
                                 java.lang.String diagnosticMessage,
                                 java.lang.String matchedDN,
                                 java.lang.String[] referralURLs,
                                 MultiUpdateChangesApplied changesApplied,
                                 java.util.List<ObjectPair<OperationType,LDAPResult>> results,
                                 Control... controls)
                          throws LDAPException
Creates a new multi-update extended request with the provided information.

Parameters:
messageID - The message ID for this extended result.
resultCode - The result code for this result. It must not be null.
diagnosticMessage - The diagnostic message to include in the result. It may be null if no diagnostic message should be included.
matchedDN - The matched DN to include in the result. It may be null if no matched DN should be included.
referralURLs - The set of referral URLs to include in the result. It may be null or empty if no referral URLs should be included.
changesApplied - The value which indicates whether any or all of the changes from the request were successfully applied.
results - The set of operation results to be included in the extended result value. It may be null or empty if no operation results should be included.
controls - The set of controls to include in the multi-update result. It may be null or empty if no controls should be included.
Throws:
LDAPException - If any of the results are for an inappropriate operation type.
Method Detail

getChangesApplied

public MultiUpdateChangesApplied getChangesApplied()
Retrieves the value that indicates whether any or all changes from the multi-update request were successfully applied.

Returns:
The value that indicates whether any or all changes from the multi-update request were successfully applied.

getResults

public java.util.List<ObjectPair<OperationType,LDAPResult>> getResults()
Retrieves a list of the results for operations processed as part of the multi-update operation, with each result paired with its corresponding operation type.

Returns:
A list of the results for operations processed as part of the multi-update operation. The returned list may be empty if no operation results were available.

getExtendedResultName

public java.lang.String getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.

Overrides:
getExtendedResultName in class ExtendedResult
Returns:
The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended result to the provided buffer.

Specified by:
toString in interface LDAPResponse
Overrides:
toString in class ExtendedResult
Parameters:
buffer - The buffer to which a string representation of this extended result will be appended.