org.apache.directory.api.ldap.model.message
Class SearchResultReferenceImpl

java.lang.Object
  org.apache.directory.api.ldap.model.message.AbstractMessage
      org.apache.directory.api.ldap.model.message.AbstractResponse
          org.apache.directory.api.ldap.model.message.SearchResultReferenceImpl

All Implemented Interfaces:

Message, Response, SearchResultReference

public class SearchResultReferenceImpl
extends AbstractResponse
implements SearchResultReference

SearchResponseReference implementation

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Fields inherited from interface org.apache.directory.api.ldap.model.message.SearchResultReference

TYPE

Constructor Summary

SearchResultReferenceImpl()
Creates a SearchResponseReference as a reply to an SearchRequest to indicate the end of a search operation.

SearchResultReferenceImpl(int id)
Creates a SearchResponseReference as a reply to an SearchRequest to indicate the end of a search operation.

Method Summary

boolean	equals(Object obj) Checks to see if an object is equal to this SearchResponseReference stub.
Referral	getReferral() Gets the sequence of LdapUrls as a Referral instance.
int	hashCode()
void	setReferral(Referral referral) Sets the sequence of LdapUrls as a Referral instance.
String	toString() Returns the Search Result Reference string

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

SearchResultReferenceImpl

public SearchResultReferenceImpl()

Creates a SearchResponseReference as a reply to an SearchRequest to indicate the end of a search operation.

SearchResultReferenceImpl

public SearchResultReferenceImpl(int id)

Creates a SearchResponseReference as a reply to an SearchRequest to indicate the end of a search operation.

Parameters:

id - the session unique message id

Method Detail

getReferral

public Referral getReferral()

Gets the sequence of LdapUrls as a Referral instance.

Specified by:

getReferral in interface SearchResultReference

Returns:

the sequence of LdapUrls

setReferral

public void setReferral(Referral referral)

Sets the sequence of LdapUrls as a Referral instance.

Specified by:

setReferral in interface SearchResultReference

Parameters:

referral - the sequence of LdapUrls

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMessage

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see if an object is equal to this SearchResponseReference stub.

Overrides:

equals in class AbstractMessage

Parameters:

obj - the object to compare to this response stub

Returns:

true if the objects are equivalent false otherwise

toString

public String toString()

Returns the Search Result Reference string

Overrides:

toString in class Object

Returns:

The Search Result Reference string