org.apache.directory.api.ldap.model.message
Interface SearchResultReference

All Superinterfaces:

Message, Response

All Known Implementing Classes:

SearchResultReferenceImpl

public interface SearchResultReference
extends Response

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

Author:

Apache Directory Project

Field Summary

static MessageTypeEnum

TYPE Search reference response message type enumeration value

Method Summary

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

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

TYPE

static final MessageTypeEnum TYPE

Search reference response message type enumeration value

Method Detail

getReferral

Referral getReferral()

Gets the sequence of LdapUrls as a Referral instance.

Returns:

the sequence of LdapUrls

setReferral

void setReferral(Referral referral)

Sets the sequence of LdapUrls as a Referral instance.

Parameters:

referral - the sequence of LdapUrls