org.apache.directory.shared.ldap.message
Interface CompareRequest

All Superinterfaces:

AbandonableRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

All Known Implementing Classes:

CompareRequestImpl

public interface CompareRequest
extends SingleReplyRequest, AbandonableRequest

Compare request protocol message that tests an entry to see if it abides by an attribute value assertion.

Version:

$Revision: 469957 $

Author:

Apache Directory Project

Field Summary

static MessageTypeEnum	RESP_TYPE Compare response message type enum code
static MessageTypeEnum	TYPE Compare request message type enum code

Method Summary

byte[]	getAssertionValue() Gets the attribute value to use in making the comparison.
java.lang.String	getAttributeId() Gets the attribute id use in making the comparison.
LdapDN	getName() Gets the distinguished name of the entry to be compared using the attribute value assertion.
void	setAssertionValue(byte[] value) Sets the attribute value to use in the comparison.
void	setAssertionValue(java.lang.String value) Sets the attribute value to use in the comparison.
void	setAttributeId(java.lang.String attrId) Sets the attribute id used in the comparison.
void	setName(LdapDN name) Sets the distinguished name of the entry to be compared using the attribute value assertion.

Methods inherited from interface org.apache.directory.shared.ldap.message.SingleReplyRequest

getResponseType

Methods inherited from interface org.apache.directory.shared.ldap.message.ResultResponseRequest

getResultResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.Request

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.Message

add, get, getControls, getMessageId, getType, put, remove

Methods inherited from interface org.apache.directory.shared.ldap.message.AbandonableRequest

abandon, addAbandonListener, isAbandoned

Field Detail

TYPE

static final MessageTypeEnum TYPE

Compare request message type enum code

RESP_TYPE

static final MessageTypeEnum RESP_TYPE

Compare response message type enum code

Method Detail

getName

LdapDN getName()

Gets the distinguished name of the entry to be compared using the attribute value assertion.

Returns:

the DN of the compared entry.

setName

void setName(LdapDN name)

Sets the distinguished name of the entry to be compared using the attribute value assertion.

Parameters:

name - the DN of the compared entry.

getAssertionValue

byte[] getAssertionValue()

Gets the attribute value to use in making the comparison.

Returns:

the attribute value to used in comparison.

setAssertionValue

void setAssertionValue(java.lang.String value)

Sets the attribute value to use in the comparison.

Parameters:

value - the attribute value used in comparison.

setAssertionValue

void setAssertionValue(byte[] value)

Sets the attribute value to use in the comparison.

Parameters:

value - the attribute value used in comparison.

getAttributeId

java.lang.String getAttributeId()

Gets the attribute id use in making the comparison.

Returns:

the attribute id used in comparison.

setAttributeId

void setAttributeId(java.lang.String attrId)

Sets the attribute id used in the comparison.

Parameters:

attrId - the attribute id used in comparison.