org.opends.server.types
Class SearchResultReference

java.lang.Object
  org.opends.server.types.SearchResultReference

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class SearchResultReference
extends java.lang.Object

This class defines a data structure for storing information about a referral returned while processing a search request.

Constructor Summary

SearchResultReference(java.util.List<java.lang.String> referralURLs)
Creates a new search result reference with the provided set of referral URLs and no controls.

SearchResultReference(java.util.List<java.lang.String> referralURLs, java.util.List<Control> controls)
Creates a new search result reference with the provided set of referral URLs and no controls.

SearchResultReference(java.lang.String referralURL)
Creates a new search result reference with the provided referral URL.

Method Summary

java.util.List<Control>	getControls() Retrieves the set of controls to include with this search result reference when it is sent to the client.
java.util.List<java.lang.String>	getReferralURLs() Retrieves the set of referral URLs for this search result reference.
java.lang.String	getReferralURLString() Retrieves a string representation of the referral URL(s) for this search result reference.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResultReference

public SearchResultReference(java.lang.String referralURL)

Creates a new search result reference with the provided referral URL.

Parameters:

referralURL - The referral URL for this search result reference.

SearchResultReference

public SearchResultReference(java.util.List<java.lang.String> referralURLs)

Creates a new search result reference with the provided set of referral URLs and no controls.

Parameters:

referralURLs - The referral URLs for this search result reference.

SearchResultReference

public SearchResultReference(java.util.List<java.lang.String> referralURLs,
                             java.util.List<Control> controls)

Creates a new search result reference with the provided set of referral URLs and no controls.

Parameters:

referralURLs - The referral URLs for this search result reference.

controls - The set of controls for this search result reference.

Method Detail

getReferralURLs

public java.util.List<java.lang.String> getReferralURLs()

Retrieves the set of referral URLs for this search result reference. It may be modified by the caller.

Returns:

The set of referral URLs for this search result reference.

getReferralURLString

public java.lang.String getReferralURLString()

Retrieves a string representation of the referral URL(s) for this search result reference.

Returns:

A string representation of the referral URL(s) for this search result reference.

getControls

public java.util.List<Control> getControls()

Retrieves the set of controls to include with this search result reference when it is sent to the client. This set may be modified by the caller.

Returns:

The set of controls to include with this search result reference when it is sent to the client.