org.opends.server.types
Interface SynchronizationProviderResult

All Known Implementing Classes:

SynchronizationProviderResult.ContinueProcessing, SynchronizationProviderResult.StopProcessing

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface SynchronizationProviderResult

This class defines a data structure that holds information about the result of processing by a synchronization provider.

Nested Class Summary

static class	SynchronizationProviderResult.ContinueProcessing Defines a continue processing synchronization provider result.
static class	SynchronizationProviderResult.StopProcessing Defines a stop processing synchronization provider result.

Method Summary

boolean	continueProcessing() Indicates whether processing on the associated operation should continue.
Message	getErrorMessage() Retrieves the error message if continueProcessing returned false.
DN	getMatchedDN() Retrieves the matched DN for the operation if continueProcessing returned false.
java.util.List<java.lang.String>	getReferralURLs() Retrieves the referral URLs for the operation if continueProcessing returned false.
ResultCode	getResultCode() Retrieves the result code for the operation if continueProcessing returned false.

Method Detail

continueProcessing

boolean continueProcessing()

Indicates whether processing on the associated operation should continue.

Returns:

true if processing on the associated operation should continue, or false if it should stop.

getErrorMessage

Message getErrorMessage()

Retrieves the error message if continueProcessing returned false.

Returns:

An error message explaining why processing should stop or null if none is provided.

getResultCode

ResultCode getResultCode()

Retrieves the result code for the operation if continueProcessing returned false.

Returns:

the result code for the operation or null if none is provided.

getMatchedDN

DN getMatchedDN()

Retrieves the matched DN for the operation if continueProcessing returned false.

Returns:

the matched DN for the operation or null if none is provided.

getReferralURLs

java.util.List<java.lang.String> getReferralURLs()

Retrieves the referral URLs for the operation if continueProcessing returned false.

Returns:

the refferal URLs for the operation or null if none is provided.