oracle.oud.responses

Interface SearchResultReference

public interface SearchResultReference

A Search Result Reference represents an area not yet explored during a Search operation.

Method Summary

Modifier and Type	Method and Description
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.
<C extends Control> C	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

addControl

SearchResultReference addControl(Control control)
                          throws java.lang.UnsupportedOperationException,
                                 java.lang.NullPointerException

Adds the provided control to this response.

Parameters:

control - The control to be added.

Returns:

This response.

Throws:

java.lang.UnsupportedOperationException - If this response does not permit controls to be added.

java.lang.NullPointerException - If control was null.

removeControl

SearchResultReference removeControl(Control control)
                             throws java.lang.UnsupportedOperationException,
                                    java.lang.NullPointerException

Removes the provided control from this response.

Parameters:

control - The control to be removed from this response.

Returns:

This response.

Throws:

java.lang.UnsupportedOperationException - If this response does not permit controls to be removed.

java.lang.NullPointerException - If control was null.

addURI

SearchResultReference addURI(java.lang.String uri)
                      throws java.lang.UnsupportedOperationException,
                             java.lang.NullPointerException

Adds the provided continuation reference URI to this search result reference.

Parameters:

uri - The continuation reference URI to be added.

Returns:

This search result reference.

Throws:

java.lang.UnsupportedOperationException - If this search result reference does not permit continuation reference URI to be added.

java.lang.NullPointerException - If uri was null.

removeURI

SearchResultReference removeURI(java.lang.String uri)
                         throws java.lang.UnsupportedOperationException,
                                java.lang.NullPointerException

Removes the provided continuation reference URI from this search result reference.

Parameters:

uri - The continuation reference URI to be added.

Returns:

This search result reference.

Throws:

java.lang.UnsupportedOperationException - If this search result reference does not permit continuation reference URI to be added.

java.lang.NullPointerException - If uri was null.

getURIs

java.util.List<java.lang.String> getURIs()

Returns a 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.

Returns:

A List containing the continuation reference URIs.

getControl

<C extends Control> C getControl(ControlDecoder<C> decoder)
                          throws java.lang.NullPointerException,
                                 PluginException

Decodes and returns the first control in this response having an OID corresponding to the provided control decoder.

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

Returns:

The decoded control, or null if the control is not included with this response.

Throws:

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.

getControls

java.util.List<Control> getControls()

Returns a List containing the controls included with this response. The returned List may be modified if permitted by this response.

Returns:

A List containing the controls.