org.opends.server.api.plugin
Class PluginResult.ImportLDIF

java.lang.Object
  extended by org.opends.server.api.plugin.PluginResult.ImportLDIF
Enclosing class:
PluginResult

public static final class PluginResult.ImportLDIF
extends java.lang.Object

Defines a LDIF plugin result for import from LDIF processing consisting of either continue, skip further plugins, or stop processing with an error message.


Method Summary
static PluginResult.ImportLDIF continueEntryProcessing()
          Defines a continue processing LDIF import plugin result.
 boolean continuePluginProcessing()
          Whether to invoke the rest of the plugins.
 boolean continueProcessing()
          Whether to continue operation processing.
 Message getErrorMessage()
          Retrieves the error message if continueProcessing returned false.
static PluginResult.ImportLDIF skipFurtherPluginProcesssing()
          Defines a skip further plugin processing LDIF import plugin result.
static PluginResult.ImportLDIF stopEntryProcessing(Message errorMessage)
          Defines a new stop processing LDIF import plugin result.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

continueEntryProcessing

public static PluginResult.ImportLDIF continueEntryProcessing()
Defines a continue processing LDIF import plugin result.

Returns:
a continue processing LDIF import plugin result.

skipFurtherPluginProcesssing

public static PluginResult.ImportLDIF skipFurtherPluginProcesssing()
Defines a skip further plugin processing LDIF import plugin result.

Returns:
a skip further plugin processing LDIF import plugin result.

stopEntryProcessing

public static PluginResult.ImportLDIF stopEntryProcessing(Message errorMessage)
Defines a new stop processing LDIF import plugin result.

Parameters:
errorMessage - An message explaining why processing should stop for the given entry.
Returns:
a new stop processing LDIF import plugin result.

continueProcessing

public boolean continueProcessing()
Whether to continue operation processing.

Returns:
true if processing should continue or false otherwise.

continuePluginProcessing

public boolean continuePluginProcessing()
Whether to invoke the rest of the plugins.

Returns:
true if the rest of the plugins should be invoked for false to skip the rest of the plugins.

getErrorMessage

public 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.