Package 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.OperationResultContract for operation results.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancontinueProcessing()Indicates whether processing on the associated operation should continue.org.forgerock.i18n.LocalizableMessagegetErrorMessage()Retrieves the error message ifcontinueProcessing()returnedfalse.DNgetMatchedDN()Retrieves the matched DN for the operation ifcontinueProcessing()returnedfalse.List<String>getReferralURLs()Retrieves the referral URLs for the operation ifcontinueProcessing()returnedfalse.ResultCodegetResultCode()Retrieves the result code for the operation ifcontinueProcessing()returnedfalse.
-
-
-
Method Detail
-
continueProcessing
boolean continueProcessing()
Indicates whether processing on the associated operation should continue.- Returns:
trueif processing on the associated operation should continue, orfalseif it should stop.
-
getErrorMessage
org.forgerock.i18n.LocalizableMessage getErrorMessage()
Retrieves the error message ifcontinueProcessing()returnedfalse.- Returns:
- An error message explaining why processing should stop or
nullif none is provided.
-
getResultCode
ResultCode getResultCode()
Retrieves the result code for the operation ifcontinueProcessing()returnedfalse.- Returns:
- the result code for the operation or
nullif none is provided.
-
getMatchedDN
DN getMatchedDN()
Retrieves the matched DN for the operation ifcontinueProcessing()returnedfalse.- Returns:
- the matched DN for the operation or
nullif none is provided.
-
getReferralURLs
List<String> getReferralURLs()
Retrieves the referral URLs for the operation ifcontinueProcessing()returnedfalse.- Returns:
- the referral URLs for the operation or
nullif none is provided.
-
-