Class SearchEntryPluginResult
- java.lang.Object
-
- com.unboundid.directory.sdk.ds.types.SearchEntryPluginResult
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchEntryPluginResult extends java.lang.Object implements java.io.Serializable
This class defines a structure which may be used to provide information about the result of the processing performed by a search entry plugin.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static SearchEntryPluginResult
SUCCESS
A predefined result instance that indicates all processing completed successfully.
-
Constructor Summary
Constructors Constructor Description SearchEntryPluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendEntry, boolean continueSearchProcessing)
Creates a new search entry plugin result with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Field Detail
-
SUCCESS
public static final SearchEntryPluginResult SUCCESS
A predefined result instance that indicates all processing completed successfully.
-
-
Constructor Detail
-
SearchEntryPluginResult
public SearchEntryPluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendEntry, boolean continueSearchProcessing)
Creates a new search entry plugin result with the provided information.- Parameters:
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.
-
-
Method Detail
-
connectionTerminated
public boolean connectionTerminated()
Indicates whether the client connection was terminated by the plugin.- Returns:
true
if the client connection was terminated by the plugin, orfalse
if not.
-
continuePluginProcessing
public boolean continuePluginProcessing()
Indicates whether to continue processing other search entry plugins for the associated entry.- Returns:
true
if the server should continue processing other search entry plugins for the associated entry, orfalse
if not.
-
continueSearchProcessing
public boolean continueSearchProcessing()
Indicates whether to continue processing for the associated search operation.- Returns:
true
if the server should continue processing for the associated search operation, orfalse
if not and the search done response should be sent to the client.
-
sendEntry
public boolean sendEntry()
Indicates whether the associated entry should be returned to the client.- Returns:
true
if the entry should be returned to the client, orfalse
if the server should exclude the entry from the set of search results.
-
toString
public java.lang.String toString()
Retrieves a string representation of this search entry plugin result.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this search entry plugin result.
-
-