Class SearchReferencePluginResult
- java.lang.Object
-
- com.unboundid.directory.sdk.ds.types.SearchReferencePluginResult
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchReferencePluginResult 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 reference plugin.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static SearchReferencePluginResult
SUCCESS
A predefined result instance that indicates all processing completed successfully.
-
Constructor Summary
Constructors Constructor Description SearchReferencePluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendReference, boolean continueSearchProcessing)
Creates a new search reference 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 reference plugins for the associated search reference.boolean
continueSearchProcessing()
Indicates whether to continue processing for the associated search operation.boolean
sendReference()
Indicates whether the associated reference should be returned to the client.java.lang.String
toString()
Retrieves a string representation of this search reference plugin result.
-
-
-
Field Detail
-
SUCCESS
public static final SearchReferencePluginResult SUCCESS
A predefined result instance that indicates all processing completed successfully.
-
-
Constructor Detail
-
SearchReferencePluginResult
public SearchReferencePluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendReference, boolean continueSearchProcessing)
Creates a new search reference 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 reference plugins for the reference.sendReference
- Indicates whether to send the reference 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 reference plugins for the associated search reference.- Returns:
true
if the server should continue processing other search reference plugins for the associated search reference, 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.
-
sendReference
public boolean sendReference()
Indicates whether the associated reference should be returned to the client.- Returns:
true
if the reference should be returned to the client, orfalse
if the server should exclude the reference from the set of search results.
-
toString
public java.lang.String toString()
Retrieves a string representation of this search reference plugin result.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this search reference plugin result.
-
-