|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchResultReference
A Search Result Reference represents an area not yet explored during a Search operation.
Method Summary | ||
---|---|---|
SearchResultReference |
addControl(Control control) Adds the provided control to this response. |
|
SearchResultReference |
addURI(java.lang.String uri) Adds the provided continuation reference URI to this search result reference. |
|
|
getControl(ControlDecoder<C> decoder) Decodes and returns the first control in this response having an OID corresponding to the provided control decoder. |
|
java.util.List<Control> |
getControls() Returns a List containing the controls included with this response. |
|
java.util.List<java.lang.String> |
getURIs() Returns a List containing the continuation reference URIs included with this search result reference. |
|
SearchResultReference |
removeControl(Control control) Removes the provided control from this response. |
|
SearchResultReference |
removeURI(java.lang.String uri) Removes the provided continuation reference URI from this search result reference. |
Method Detail |
---|
SearchResultReference addControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
control
- The control to be added.java.lang.UnsupportedOperationException
- If this response does not permit controls to be added.java.lang.NullPointerException
- If control
was null
.SearchResultReference removeControl(Control control) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
control
- The control to be removed from this response.java.lang.UnsupportedOperationException
- If this response does not permit controls to be removed.java.lang.NullPointerException
- If control
was null
.SearchResultReference addURI(java.lang.String uri) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
uri
- The continuation reference URI to be added.java.lang.UnsupportedOperationException
- If this search result reference does not permit continuation reference URI to be added.java.lang.NullPointerException
- If uri
was null
.SearchResultReference removeURI(java.lang.String uri) throws java.lang.UnsupportedOperationException, java.lang.NullPointerException
uri
- The continuation reference URI to be added.java.lang.UnsupportedOperationException
- If this search result reference does not permit continuation reference URI to be added.java.lang.NullPointerException
- If uri
was null
.java.util.List<java.lang.String> getURIs()
List
containing the continuation reference URIs included with this search result reference. The returned List
may be modified if permitted by this search result reference.List
containing the continuation reference URIs.<C extends Control> C getControl(ControlDecoder<C> decoder) throws java.lang.NullPointerException, PluginException
C
- The type of control to be decoded and returned.decoder
- The control decoder.null
if the control is not included with this response.PluginException
- If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).java.lang.NullPointerException
- If decoder
or options
was null
.java.util.List<Control> getControls()
List
containing the controls included with this response. The returned List
may be modified if permitted by this response.List
containing the controls.
|
Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory 11g Release 2 (11.1.2.2.0) E38583-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |