public interface SearchResultReference extends Response
Modifier and Type | Method and Description |
---|---|
SearchResultReference |
addControl(Control control)
Adds the provided control to this response.
|
SearchResultReference |
addURI(String uri)
Adds the provided continuation reference URI to this search result
reference.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this response having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
response. |
List<String> |
getURIs()
Returns a
List containing the continuation reference URIs
included with this search result reference. |
containsControl
SearchResultReference addControl(Control control)
Response
addControl
in interface Response
control
- The control to be added.SearchResultReference addURI(String uri)
uri
- The continuation reference URI to be added.UnsupportedOperationException
- If this search result reference does not permit continuation
reference URI to be added.NullPointerException
- If uri
was null
.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Response
getControl
in interface Response
C
- The type of control to be decoded and returned.decoder
- The control decoder.options
- The set of decode options which should be used when decoding
the control.null
if the control is not
included with this response.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).List<Control> getControls()
Response
List
containing the controls included with this
response. The returned List
may be modified if permitted by this
response.getControls
in interface Response
List
containing the controls.Copyright 2010-2017 ForgeRock AS.