@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchEntryPluginResult extends java.lang.Object implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static SearchEntryPluginResult |
SUCCESS
A predefined result instance that indicates all processing completed
successfully.
|
Constructor and Description |
---|
SearchEntryPluginResult(boolean connectionTerminated,
boolean continuePluginProcessing,
boolean sendEntry,
boolean continueSearchProcessing)
Creates a new search entry plugin result with the provided information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
connectionTerminated()
Indicates whether the client connection was terminated by the plugin.
|
boolean |
continuePluginProcessing()
Indicates whether to continue processing other search entry plugins for
the associated entry.
|
boolean |
continueSearchProcessing()
Indicates whether to continue processing for the associated search
operation.
|
boolean |
sendEntry()
Indicates whether the associated entry should be returned to the client.
|
java.lang.String |
toString()
Retrieves a string representation of this search entry plugin result.
|
public static final SearchEntryPluginResult SUCCESS
public SearchEntryPluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendEntry, boolean continueSearchProcessing)
connectionTerminated
- Indicates whether the client connection
was terminated by the plugin.continuePluginProcessing
- Indicates whether to continue processing
other search entry plugins for the
entry.sendEntry
- Indicates whether to send the entry to
the client.continueSearchProcessing
- Indicates whether to continue processing
the associated search operation.public boolean connectionTerminated()
true
if the client connection was terminated by the
plugin, or false
if not.public boolean continuePluginProcessing()
true
if the server should continue processing other
search entry plugins for the associated entry, or false
if
not.public boolean continueSearchProcessing()
true
if the server should continue processing for the
associated search operation, or false
if not and the
search done response should be sent to the client.public boolean sendEntry()
true
if the entry should be returned to the client, or
false
if the server should exclude the entry from the
set of search results.public java.lang.String toString()
toString
in class java.lang.Object