org.apache.directory.api.ldap.extras.controls.vlv

Interface VirtualListViewRequest

All Superinterfaces:

Control

All Known Implementing Classes:

VirtualListViewRequestDecorator, VirtualListViewRequestImpl

public interface VirtualListViewRequest
extends Control

Virtual List View control as specified in draft-ietf-ldapext-ldapv3-vlv-09. VirtualListViewRequest ::= SEQUENCE { beforeCount INTEGER (0..maxInt), afterCount INTEGER (0..maxInt), target CHOICE { byOffset [0] SEQUENCE { offset INTEGER (1 .. maxInt), contentCount INTEGER (0 .. maxInt) }, greaterThanOrEqual [1] AssertionValue }, contextID OCTET STRING OPTIONAL } Note : the target is set accordingly to which of the setOffset() or assertionValue() method is called last.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OID This control OID

Method Summary

Modifier and Type	Method and Description
int	getAfterCount()
byte[]	getAssertionValue()
int	getBeforeCount()
int	getContentCount()
byte[]	getContextId()
int	getOffset()
boolean	hasAssertionValue()
boolean	hasOffset()
void	setAfterCount(int afterCount)
void	setAssertionValue(byte[] assertionValue)
void	setBeforeCount(int beforeCount)
void	setContentCount(int contentCount)
void	setContextId(byte[] contextId)
void	setOffset(int offset)

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

getOid, isCritical, setCritical

Field Detail

OID

static final java.lang.String OID

This control OID

See Also:

Constant Field Values

Method Detail

getBeforeCount

int getBeforeCount()

Returns:

The number of entries before the target entry that are going to be sent

setBeforeCount

void setBeforeCount(int beforeCount)

Parameters:

beforeCount - Set the number of entries to be returned before the target entry

getAfterCount

int getAfterCount()

Returns:

The number of entries after the target entry that are going to be sent

setAfterCount

void setAfterCount(int afterCount)

Parameters:

beforeCount - Set the number of entries to be returned after the target entry

getOffset

int getOffset()

Returns:

The position of the target entry

setOffset

void setOffset(int offset)

Parameters:

the - position of the target entry

getContentCount

int getContentCount()

Returns:

The number of expected entries

setContentCount

void setContentCount(int contentCount)

Parameters:

contentCount - The number of entries

getAssertionValue

byte[] getAssertionValue()

Returns:

The AssertionValue

setAssertionValue

void setAssertionValue(byte[] assertionValue)

Parameters:

assertionValue - Set the AssertionValue

getContextId

byte[] getContextId()

Returns:

The ID used for this request

setContextId

void setContextId(byte[] contextId)

Parameters:

contextId - Set the context ID

hasOffset

boolean hasOffset()

Returns:

true if the VLV target is an offset, false otherwise

hasAssertionValue

boolean hasAssertionValue()

Returns:

true if the VLV target is an assertionValue, false otherwise