org.opends.server.types.operation
Interface PreParseAbandonOperation

All Superinterfaces:
PluginOperation, PreParseOperation
All Known Implementing Classes:
AbandonOperationBasis

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface PreParseAbandonOperation
extends PreParseOperation

This class defines a set of methods that are available for use by pre-parse plugins for abandon operations. Note that this interface is intended only to define an API for use by plugins and is not intended to be implemented by any custom classes.


Method Summary
 int getIDToAbandon()
          Retrieves the message ID of the operation that should be abandoned.
 
Methods inherited from interface org.opends.server.types.operation.PreParseOperation
addRequestControl, addResponseControl, appendAdditionalLogMessage, appendErrorMessage, getAdditionalLogMessage, getErrorMessage, removeRequestControl, removeResponseControl, setAdditionalLogMessage, setErrorMessage
 
Methods inherited from interface org.opends.server.types.operation.PluginOperation
checkIfCanceled, disconnectClient, getAttachment, getAttachments, getClientConnection, getConnectionID, getMessageID, getOperationID, getOperationType, getProcessingStartTime, getRequestControls, getResponseControls, isInternalOperation, isSynchronizationOperation, removeAttachment, setAttachment, toString, toString
 

Method Detail

getIDToAbandon

int getIDToAbandon()
Retrieves the message ID of the operation that should be abandoned.

Returns:
The message ID of the operation that should be abandoned.