org.forgerock.opendj.ldap.messages

Interface SearchResultReference

All Superinterfaces:

ProtocolOp, Response

public interface SearchResultReference
extends Response

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 protocol-op.
SearchResultReference	addControls(Iterable<? extends Control> controls) Adds the provided controls to this protocol-op.
SearchResultReference	addUri(String uri) Adds the provided continuation reference URI to this search result reference.
<C extends Control> C	getControl(ControlDecoder<C> decoder, DecodeOptions options) Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
List<Control>	getControls() Returns a List containing the controls included with this protocol-op.
List<String>	getUris() Returns a List containing the continuation reference URIs included with this search result reference.

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl

Method Detail

addControl

SearchResultReference addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Response

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

SearchResultReference addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Response

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

addUri

SearchResultReference addUri(String uri)

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:

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

NullPointerException - If uri was null.

getControl

<C extends Control> C getControl(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException

Description copied from interface: ProtocolOp

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

Specified by:

getControl in interface ProtocolOp

Type Parameters:

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

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

Throws:

DecodeException - 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).

getControls

List<Control> getControls()

Description copied from interface: ProtocolOp

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

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.

getUris

List<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.