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

Class VirtualListViewResponseImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.controls.AbstractControl

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

All Implemented Interfaces:

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

public class VirtualListViewResponseImpl
extends org.apache.directory.api.ldap.model.message.controls.AbstractControl
implements VirtualListViewResponse

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
private int	contentCount
private byte[]	contextId
private int	targetPosition
private VirtualListViewResultCode	virtualListViewResult

Fields inherited from interface org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewResponse

OID

Constructor Summary

Constructors

Constructor and Description
VirtualListViewResponseImpl() Creates a new VirtualListViewResponseImpl instance

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getContentCount()
byte[]	getContextId()
int	getTargetPosition()
VirtualListViewResultCode	getVirtualListViewResult()
int	hashCode()
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
String	toString() Return a String representing this VirtualListViewResponseImpl.

Methods inherited from class org.apache.directory.api.ldap.model.message.controls.AbstractControl

getOid, isCritical, setCritical

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getOid, isCritical, setCritical

Field Detail

targetPosition

private int targetPosition

contentCount

private int contentCount

virtualListViewResult

private VirtualListViewResultCode virtualListViewResult

contextId

private byte[] contextId

Constructor Detail

VirtualListViewResponseImpl

public VirtualListViewResponseImpl()

Creates a new VirtualListViewResponseImpl instance

Method Detail

getTargetPosition

public int getTargetPosition()

Specified by:

getTargetPosition in interface VirtualListViewResponse

Returns:

the position in the list of entries

setTargetPosition

public void setTargetPosition(int targetPosition)

Description copied from interface: VirtualListViewResponse

Sets the position in the list of entries

Specified by:

setTargetPosition in interface VirtualListViewResponse

Parameters:

targetPosition - the position in the list of entries

getContentCount

public int getContentCount()

Specified by:

getContentCount in interface VirtualListViewResponse

Returns:

The number of returned entries

setContentCount

public void setContentCount(int contentCount)

Description copied from interface: VirtualListViewResponse

Sets the number of returned entries

Specified by:

setContentCount in interface VirtualListViewResponse

Parameters:

contentCount - The number of returned entries

getVirtualListViewResult

public VirtualListViewResultCode getVirtualListViewResult()

Specified by:

getVirtualListViewResult in interface VirtualListViewResponse

Returns:

The VLV result

setVirtualListViewResult

public void setVirtualListViewResult(VirtualListViewResultCode virtualListViewResultCode)

Description copied from interface: VirtualListViewResponse

Store the VLV result

Specified by:

setVirtualListViewResult in interface VirtualListViewResponse

Parameters:

virtualListViewResultCode - The result

getContextId

public byte[] getContextId()

Specified by:

getContextId in interface VirtualListViewResponse

Returns:

The context ID

setContextId

public void setContextId(byte[] contextId)

Description copied from interface: VirtualListViewResponse

Sets the context ID

Specified by:

setContextId in interface VirtualListViewResponse

Parameters:

contextId - The context ID

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.hashCode()

equals

public boolean equals(Object o)

Overrides:

equals in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.equals(Object)

toString

public String toString()

Return a String representing this VirtualListViewResponseImpl.

Overrides:

toString in class org.apache.directory.api.ldap.model.message.controls.AbstractControl