org.apache.directory.shared.dsmlv2.reponse

Class SearchResultEntryDsml

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

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

org.apache.directory.shared.dsmlv2.LdapMessageDecorator

org.apache.directory.shared.dsmlv2.reponse.LdapResponseDecorator

org.apache.directory.shared.dsmlv2.reponse.SearchResultEntryDsml

All Implemented Interfaces:

Asn1Object, DsmlDecorator

public class SearchResultEntryDsml
extends LdapResponseDecorator
implements DsmlDecorator

DSML Decorator for SearchResultEntry

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator

instance

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
SearchResultEntryDsml() Creates a new instance of SearchResultEntryDsml.
SearchResultEntryDsml(SearchResultEntryCodec ldapMessage) Creates a new instance of SearchResultEntryDsml.

Method Summary

Modifier and Type	Method and Description
void	addAttributeValue(Object value) Add a new value to the current attribute
void	addAttributeValues(String type) Create a new attributeValue
String	getCurrentAttributeValueType()
Entry	getEntry() Get the entry.
MessageTypeEnum	getMessageType() Get the message type
DN	getObjectName() Get the entry DN
void	setEntry(Entry entry) Initialize the entry.
void	setObjectName(DN objectName) Set the entry DN
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.shared.dsmlv2.reponse.LdapResponseDecorator

getLdapResponseLength, getLdapResult, setLdapResult

Methods inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator

addControl, addLength, computeLength, computeLengthProtocolOp, encode, encodeProtocolOp, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getCurrentLength, getDelRequest, getDelResponse, getExpectedLength, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getParent, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, setCurrentLength, setExpectedLength, setMessageId, setParent, toString

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

addControls, encode, getCodecControl, initControls, toString

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

getTlvId

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultEntryDsml

public SearchResultEntryDsml()

Creates a new instance of SearchResultEntryDsml.

SearchResultEntryDsml

public SearchResultEntryDsml(SearchResultEntryCodec ldapMessage)

Creates a new instance of SearchResultEntryDsml.

Parameters:

ldapMessage - the message to decorate

Method Detail

getMessageType

public MessageTypeEnum getMessageType()

Description copied from class: LdapMessageCodec

Get the message type

Overrides:

getMessageType in class LdapMessageDecorator

Returns:

The message type

toDsml

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

Description copied from interface: DsmlDecorator

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

Specified by:

toDsml in interface DsmlDecorator

Parameters:

root - the root dom4j Element

Returns:

the dom4j Element corresponding to the entry.

getObjectName

public DN getObjectName()

Get the entry DN

Returns:

Returns the objectName.

setObjectName

public void setObjectName(DN objectName)

Set the entry DN

Parameters:

objectName - The objectName to set.

getEntry

public Entry getEntry()

Get the entry.

Returns:

Returns the entry.

setEntry

public void setEntry(Entry entry)

Initialize the entry.

Parameters:

entry - the entry

addAttributeValues

public void addAttributeValues(String type)

Create a new attributeValue

Parameters:

type - The attribute's name

addAttributeValue

public void addAttributeValue(Object value)

Add a new value to the current attribute

Parameters:

value -

getCurrentAttributeValueType

public String getCurrentAttributeValueType()

Returns:

Returns the currentAttributeValue.