org.apache.directory.shared.dsmlv2.reponse

Class SearchResponse

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.LdapMessageCodec

org.apache.directory.shared.ldap.codec.LdapResponseCodec

org.apache.directory.shared.dsmlv2.reponse.SearchResponse

All Implemented Interfaces:

Asn1Object

public class SearchResponse
extends LdapResponseCodec

This class represents the DSML Search Response

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

ldapMessageLength

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
SearchResponse() Creates a new instance of SearchResponse.

Method Summary

Modifier and Type	Method and Description
boolean	addSearchResultEntry(SearchResultEntryCodec searchResultEntry) Adds a Search Result Entry
boolean	addSearchResultReference(SearchResultReferenceCodec searchResultReference) Adds a Search Result Reference
protected int	computeLengthProtocolOp()
protected void	encodeProtocolOp(ByteBuffer buffer)
SearchResultEntryCodec	getCurrentSearchResultEntry() Gets the Current Search Result Entry
SearchResultReferenceCodec	getCurrentSearchResultReference() Gets the current Search Result Reference
MessageTypeEnum	getMessageType() Get the message type
String	getMessageTypeName() Get the message type Name
SearchResultDoneCodec	getSearchResultDone() Gets the Search Result Entry
List<SearchResultEntryCodec>	getSearchResultEntryList() Gets the Search Result Entry List
List<SearchResultReferenceCodec>	getSearchResultReferenceList() Gets the Search Result Reference List
void	setSearchResultDone(SearchResultDoneCodec searchResultDone) Sets the Search Result Entry

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapResponseCodec

computeLdapResultLength, encode, getLdapResponseLength, getLdapResult, setLdapResult, toString

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

addControl, addControls, computeLength, encode, getCodecControl, getControls, getControls, getCurrentControl, getMessageId, initControls, setMessageId, toString

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResponse

public SearchResponse()

Creates a new instance of SearchResponse.

Method Detail

addSearchResultEntry

public boolean addSearchResultEntry(SearchResultEntryCodec searchResultEntry)

Adds a Search Result Entry

Parameters:

searchResultEntry - the Search Result Entry to add

Returns:

true (as per the general contract of the Collection.add method)

getCurrentSearchResultEntry

public SearchResultEntryCodec getCurrentSearchResultEntry()

Gets the Current Search Result Entry

Returns:

the current Searche Result Entry

getSearchResultEntryList

public List<SearchResultEntryCodec> getSearchResultEntryList()

Gets the Search Result Entry List

Returns:

the Search Result Entry List

addSearchResultReference

public boolean addSearchResultReference(SearchResultReferenceCodec searchResultReference)

Adds a Search Result Reference

Parameters:

searchResultReference - the Search Result Reference to add

Returns:

true (as per the general contract of the Collection.add method)

getCurrentSearchResultReference

public SearchResultReferenceCodec getCurrentSearchResultReference()

Gets the current Search Result Reference

Returns:

the current Search Result Reference

getSearchResultReferenceList

public List<SearchResultReferenceCodec> getSearchResultReferenceList()

Gets the Search Result Reference List

Returns:

the Search Result Reference List

getSearchResultDone

public SearchResultDoneCodec getSearchResultDone()

Gets the Search Result Entry

Returns:

the Search Result Entry

setSearchResultDone

public void setSearchResultDone(SearchResultDoneCodec searchResultDone)

Sets the Search Result Entry

Parameters:

searchResultDone - the Search Result Entry to set

computeLengthProtocolOp

protected int computeLengthProtocolOp()

Specified by:

computeLengthProtocolOp in class LdapMessageCodec

encodeProtocolOp

protected void encodeProtocolOp(ByteBuffer buffer)
                         throws EncoderException

Specified by:

encodeProtocolOp in class LdapMessageCodec

Throws:

EncoderException

getMessageType

public MessageTypeEnum getMessageType()

Description copied from class: LdapMessageCodec

Get the message type

Specified by:

getMessageType in class LdapMessageCodec

Returns:

The message type

getMessageTypeName

public String getMessageTypeName()

Description copied from class: LdapMessageCodec

Get the message type Name

Specified by:

getMessageTypeName in class LdapMessageCodec

Returns:

The message type name