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

Interface VirtualListViewResponse

All Superinterfaces:

org.apache.directory.api.ldap.model.message.Control

All Known Implementing Classes:

VirtualListViewResponseImpl

public interface VirtualListViewResponse
extends org.apache.directory.api.ldap.model.message.Control

Virtual List View response control as specified in draft-ietf-ldapext-ldapv3-vlv-09.

  VirtualListViewResponse ::= SEQUENCE {
         targetPosition    INTEGER (0 .. maxInt),
         contentCount     INTEGER (0 .. maxInt),
         virtualListViewResult ENUMERATED {
              success (0),
              operationsError (1),
              protocolError (3),
              unwillingToPerform (53),
              insufficientAccessRights (50),
              timeLimitExceeded (3),
              adminLimitExceeded (11),
              innapropriateMatching (18),
              sortControlMissing (60),
              offsetRangeError (61),
              other(80),
              ... 
         },
         contextID     OCTET STRING OPTIONAL 
 }
 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	OID the OID of the response control

Method Summary

Modifier and Type	Method and Description
int	getContentCount()
byte[]	getContextId()
int	getTargetPosition()
VirtualListViewResultCode	getVirtualListViewResult()
void	setContentCount(int contentCount) Sets the number of returned entries
void	setContextId(byte[] contextId) Sets the context ID
void	setTargetPosition(int targetPosition) Sets the position in the list of entries
void	setVirtualListViewResult(VirtualListViewResultCode virtualListViewResultCode) Store the VLV result

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

getOid, isCritical, setCritical

Field Detail

OID

static final String OID

the OID of the response control

See Also:

Constant Field Values

Method Detail

getTargetPosition

int getTargetPosition()

Returns:

the position in the list of entries

setTargetPosition

void setTargetPosition(int targetPosition)

Sets the position in the list of entries

Parameters:

targetPosition - the position in the list of entries

getContentCount

int getContentCount()

Returns:

The number of returned entries

setContentCount

void setContentCount(int contentCount)

Sets the number of returned entries

Parameters:

contentCount - The number of returned entries

getVirtualListViewResult

VirtualListViewResultCode getVirtualListViewResult()

Returns:

The VLV result

setVirtualListViewResult

void setVirtualListViewResult(VirtualListViewResultCode virtualListViewResultCode)

Store the VLV result

Parameters:

virtualListViewResultCode - The result

getContextId

byte[] getContextId()

Returns:

The context ID

setContextId

void setContextId(byte[] contextId)

Sets the context ID

Parameters:

contextId - The context ID