|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.ds.types.SearchEntryPluginResult
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SearchEntryPluginResult
This class defines a structure which may be used to provide information about the result of the processing performed by a search entry plugin.
Field Summary | |
---|---|
static SearchEntryPluginResult |
SUCCESS
A predefined result instance that indicates all processing completed successfully. |
Constructor Summary | |
---|---|
SearchEntryPluginResult(boolean connectionTerminated,
boolean continuePluginProcessing,
boolean sendEntry,
boolean continueSearchProcessing)
Creates a new search entry plugin result with the provided information. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final SearchEntryPluginResult SUCCESS
Constructor Detail |
---|
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.Method Detail |
---|
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |