org.opends.server.api.plugin

Interface PluginResult.OperationResult

All Known Subinterfaces:

SynchronizationProviderResult

All Known Implementing Classes:

PluginResult.IntermediateResponse, PluginResult.PostOperation, PluginResult.PreOperation, PluginResult.PreParse, PluginResult.SubordinateDelete, PluginResult.SubordinateModifyDN, SynchronizationProviderResult.ContinueProcessing, SynchronizationProviderResult.StopProcessing

Enclosing class:

PluginResult

public static interface PluginResult.OperationResult

Contract for operation results.

Method Summary

Modifier and Type	Method and Description
boolean	continueProcessing() Indicates whether processing on the associated operation should continue.
LocalizableMessage	getErrorMessage() Retrieves the error message if continueProcessing() returned false.
Dn	getMatchedDN() Retrieves the matched DN for the operation if continueProcessing() returned false.
List<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

LocalizableMessage 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

List<String> getReferralURLs()

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

Returns:

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