org.apache.directory.ldap.client.api.message
Class SearchResultReference

java.lang.Object
  extended by org.apache.directory.ldap.client.api.message.AbstractMessage
      extended by org.apache.directory.ldap.client.api.message.SearchResultReference
All Implemented Interfaces:
Message, Response, SearchResponse

public class SearchResultReference
extends AbstractMessage
implements SearchResponse

Search reference protocol response message used to return referrals to the client in response to a search request message.

Version:
$Revision: 760984 $
Author:
Apache Directory Project

Constructor Summary
SearchResultReference()
          Creates a new instance of SearchResultReferenceImpl.
 
Method Summary
 void addReferrals(org.apache.directory.shared.ldap.util.LdapURL... urls)
          Sets the sequence of LdapUrls as a Referral instance.
 void addReferrals(java.lang.String... urls)
          Sets the sequence of LdapUrls as a Referral instance.
 Referral getReferrals()
          Gets the sequence of LdapUrls as a Referral instance.
 void removeReferrals(org.apache.directory.shared.ldap.util.LdapURL... urls)
          Removes the sequence of LdapUrls from the Referral instance.
 void removeReferrals(java.lang.String... urls)
          Removes the sequence of LdapUrls from the Referral instance.
 void setReferral(Referral referral)
          Sets the sequence of LdapUrls as a Referral instance.
 
Methods inherited from class org.apache.directory.ldap.client.api.message.AbstractMessage
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.directory.ldap.client.api.message.Message
add, getControl, getControls, getMessageId, hasControl, remove, setMessageId
 

Constructor Detail

SearchResultReference

public SearchResultReference()
Creates a new instance of SearchResultReferenceImpl.

Method Detail

getReferrals

public Referral getReferrals()
Gets the sequence of LdapUrls as a Referral instance.

Returns:
the sequence of LdapUrls

setReferral

public void setReferral(Referral referral)
Sets the sequence of LdapUrls as a Referral instance.

Parameters:
referrals - the sequence of LdapUrls

addReferrals

public void addReferrals(org.apache.directory.shared.ldap.util.LdapURL... urls)
Sets the sequence of LdapUrls as a Referral instance.

Parameters:
urls - the sequence of LdapUrls

addReferrals

public void addReferrals(java.lang.String... urls)
Sets the sequence of LdapUrls as a Referral instance.

Parameters:
urls - the sequence of LdapUrls

removeReferrals

public void removeReferrals(org.apache.directory.shared.ldap.util.LdapURL... urls)
Removes the sequence of LdapUrls from the Referral instance.

Parameters:
urls - the sequence of LdapUrls

removeReferrals

public void removeReferrals(java.lang.String... urls)
Removes the sequence of LdapUrls from the Referral instance.

Parameters:
urls - the sequence of LdapUrls


Copyright © 2009-2011 Apache Software Foundation. All Rights Reserved.