oracle.oud.controls

Interface VirtualListViewResponseControl

All Superinterfaces:

Control

public interface VirtualListViewResponseControl
extends Control

The virtual list view response control as defined in draft-ietf-ldapext-ldapv3-vlv. This control is included with a search result in response to a virtual list view request included with a search request.

If the result code included with this control indicates that the virtual list view request succeeded then the content count and target position give sufficient information for the client to update a list box slider position to match the newly retrieved entries and identify the target entry.

The content count and context ID should be used in a subsequent virtual list view requests.

See Also:

VirtualListViewRequestControl, draft-ietf-ldapext-ldapv3-vlv - LDAP Extensions for Scrolling View Browsing of Search Results

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<VirtualListViewResponseControl>	DECODER A decoder which can be used for decoding the virtual list view response control.

Method Summary

Modifier and Type	Method and Description
int	getContentCount() Returns the estimated total number of entries in the result set.
ByteString	getContextID() Returns a server-defined octet string which, if present, should be sent back to the server by the client in a subsequent virtual list request.
ResultCode	getResult() Returns result code indicating the outcome of the virtual list view request.
int	getTargetPosition() Returns the position of the target entry in the result set.

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getDetails, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<VirtualListViewResponseControl> DECODER

A decoder which can be used for decoding the virtual list view response control.

Method Detail

getContentCount

int getContentCount()

Returns the estimated total number of entries in the result set.

Returns:

The estimated total number of entries in the result set.

getContextID

ByteString getContextID()

Returns a server-defined octet string which, if present, should be sent back to the server by the client in a subsequent virtual list request.

Returns:

A server-defined octet string which, if present, should be sent back to the server by the client in a subsequent virtual list request, or null if there is no context ID.

getResult

ResultCode getResult()

Returns result code indicating the outcome of the virtual list view request.

Returns:

The result code indicating the outcome of the virtual list view request.

getTargetPosition

int getTargetPosition()

Returns the position of the target entry in the result set.

Returns:

The position of the target entry in the result set.