org.opends.server.types
Class SynchronizationProviderResult.StopProcessing

java.lang.Object
  extended by org.opends.server.types.SynchronizationProviderResult.StopProcessing
All Implemented Interfaces:
SynchronizationProviderResult
Enclosing interface:
SynchronizationProviderResult

public static class SynchronizationProviderResult.StopProcessing
extends java.lang.Object
implements SynchronizationProviderResult

Defines a stop processing synchronization provider result.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opends.server.types.SynchronizationProviderResult
SynchronizationProviderResult.ContinueProcessing, SynchronizationProviderResult.StopProcessing
 
Constructor Summary
SynchronizationProviderResult.StopProcessing(ResultCode resultCode, Message errorMessage)
          Contrust a new stop processing synchronization provider result.
SynchronizationProviderResult.StopProcessing(ResultCode resultCode, Message errorMessage, DN matchedDN, java.util.List<java.lang.String> referralURLs)
          Contrust a new 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SynchronizationProviderResult.StopProcessing

public SynchronizationProviderResult.StopProcessing(ResultCode resultCode,
                                                    Message errorMessage,
                                                    DN matchedDN,
                                                    java.util.List<java.lang.String> referralURLs)
Contrust a new stop processing synchronization provider result.

Parameters:
resultCode - The result code for this result.
errorMessage - An message explaining why processing should stop.
matchedDN - The matched DN for this result.
referralURLs - The set of referral URLs for this result.

SynchronizationProviderResult.StopProcessing

public SynchronizationProviderResult.StopProcessing(ResultCode resultCode,
                                                    Message errorMessage)
Contrust a new stop processing synchronization provider result.

Parameters:
resultCode - The result code for this result.
errorMessage - An message explaining why processing should stop.
Method Detail

getResultCode

public ResultCode getResultCode()
Retrieves the result code for the operation if continueProcessing returned false.

Specified by:
getResultCode in interface SynchronizationProviderResult
Returns:
the result code for the operation or null if none is provided.

getMatchedDN

public DN getMatchedDN()
Retrieves the matched DN for the operation if continueProcessing returned false.

Specified by:
getMatchedDN in interface SynchronizationProviderResult
Returns:
the matched DN for the operation or null if none is provided.

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()
Retrieves the referral URLs for the operation if continueProcessing returned false.

Specified by:
getReferralURLs in interface SynchronizationProviderResult
Returns:
the refferal URLs for the operation or null if none is provided.

continueProcessing

public boolean continueProcessing()
Indicates whether processing on the associated operation should continue.

Specified by:
continueProcessing in interface SynchronizationProviderResult
Returns:
true if processing on the associated operation should continue, or false if it should stop.

getErrorMessage

public Message getErrorMessage()
Retrieves the error message if continueProcessing returned false.

Specified by:
getErrorMessage in interface SynchronizationProviderResult
Returns:
An error message explaining why processing should stop or null if none is provided.