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 Detail

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