org.apache.directory.api.dsmlv2.response

Class SearchResultDoneDsml

java.lang.Object

org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>

org.apache.directory.api.dsmlv2.response.AbstractResponseDsml<E>

org.apache.directory.api.dsmlv2.response.AbstractResultResponseDsml<SearchResultDone>

org.apache.directory.api.dsmlv2.response.SearchResultDoneDsml

All Implemented Interfaces:

DsmlDecorator<SearchResultDone>, Message, Response, ResultResponse, SearchResultDone

public class SearchResultDoneDsml
extends AbstractResultResponseDsml<SearchResultDone>
implements SearchResultDone

DSML Decorator for SearchResultDone

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SearchResultDoneDsml(LdapApiService codec) Creates a new getDecoratedMessage() of SearchResultDoneDsml.
SearchResultDoneDsml(LdapApiService codec, SearchResultDone ldapMessage) Creates a new getDecoratedMessage() of SearchResultDoneDsml.

Method Summary

Modifier and Type	Method and Description
MessageTypeEnum	getType() Gets the LDAP message type code associated with this Message.
org.dom4j.Element	toDsml(org.dom4j.Element root) Converts the request/reponse to its XML representation in the DSMLv2 format

Methods inherited from class org.apache.directory.api.dsmlv2.response.AbstractResultResponseDsml

getLdapResult

Methods inherited from class org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator

addAllControls, addControl, get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put, removeControl, setMessageId

Methods inherited from class java.lang.Object

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

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

getLdapResult

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

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

Constructor Detail

SearchResultDoneDsml

public SearchResultDoneDsml(LdapApiService codec)

Creates a new getDecoratedMessage() of SearchResultDoneDsml.

SearchResultDoneDsml

public SearchResultDoneDsml(LdapApiService codec,
                            SearchResultDone ldapMessage)

Creates a new getDecoratedMessage() of SearchResultDoneDsml.

Parameters:

ldapMessage - the message to decorate

Method Detail

getType

public MessageTypeEnum getType()

Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.

Specified by:

getType in interface Message

Overrides:

getType in class AbstractDsmlMessageDecorator<SearchResultDone>

Returns:

the message type code.

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)

Converts the request/reponse to its XML representation in the DSMLv2 format

Specified by:

toDsml in interface DsmlDecorator<SearchResultDone>

Specified by:

toDsml in class AbstractResultResponseDsml<SearchResultDone>

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.