oracle.oud.controls

Interface VirtualListViewRequestControl

All Superinterfaces:

Control

public interface VirtualListViewRequestControl
extends Control

The virtual list view request control as defined in draft-ietf-ldapext-ldapv3-vlv. This control allows a client to specify that the server return, for a given search request with associated sort keys, a contiguous subset of the search result set. This subset is specified in terms of offsets into the ordered list, or in terms of a greater than or equal assertion value.

This control must be used in conjunction with the server-side sort request control in order to ensure that results are returned in a consistent order.

This control is similar to the simple paged results request control, except that it allows the client to move backwards and forwards in the result set.

See Also:

VirtualListViewResponseControl, ServerSideSortRequestControl, 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<VirtualListViewRequestControl>	DECODER A decoder which can be used for decoding the virtual list view request control.

Method Summary

Modifier and Type	Method and Description
int	getAfterCount() Returns the number of entries after the target entry to be included in the search results.
ByteString	getAssertionValue() Returns the assertion value that will be used to locate the target entry, if applicable.
java.lang.String	getAssertionValueAsString() Returns the assertion value that will be used to locate the target entry, if applicable, decoded as a UTF-8 string.
int	getBeforeCount() Returns the number of entries before the target entry to be included in the search results.
int	getContentCount() Returns the content count returned by the server in the last virtual list view response, if applicable.
ByteString	getContextID() Returns the context ID provided by the server in the last virtual list view response for the same set of criteria, or null if there was no previous virtual list view response or the server did not include a context ID in the last response.
int	getOffset() Returns the positional offset of the target entry in the result set, if applicable, where 1 is the first entry.
boolean	hasTargetOffset() Returns true if this control is using a target offset, or false if this control is using a target assertion.

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getDetails, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<VirtualListViewRequestControl> DECODER

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

Method Detail

getAfterCount

int getAfterCount()

Returns the number of entries after the target entry to be included in the search results.

Returns:

The number of entries after the target entry to be included in the search results.

getAssertionValue

ByteString getAssertionValue()

Returns the assertion value that will be used to locate the target entry, if applicable.

Returns:

The assertion value that will be used to locate the target entry, or null if this control is using a target offset.

getAssertionValueAsString

java.lang.String getAssertionValueAsString()

Returns the assertion value that will be used to locate the target entry, if applicable, decoded as a UTF-8 string.

Returns:

The assertion value that will be used to locate the target entry decoded as a UTF-8 string, or null if this control is using a target offset.

getBeforeCount

int getBeforeCount()

Returns the number of entries before the target entry to be included in the search results.

Returns:

The number of entries before the target entry to be included in the search results.

getContentCount

int getContentCount()

Returns the content count returned by the server in the last virtual list view response, if applicable.

Returns:

The content count returned by the server in the last virtual list view response, which may be 0 if this is the first virtual list view request, or -1 if this control is using a target assertion.

getContextID

ByteString getContextID()

Returns the context ID provided by the server in the last virtual list view response for the same set of criteria, or null if there was no previous virtual list view response or the server did not include a context ID in the last response.

Returns:

The context ID provided by the server in the last virtual list view response, or null if unavailable.

getOffset

int getOffset()

Returns the positional offset of the target entry in the result set, if applicable, where 1 is the first entry.

Returns:

The positional offset of the target entry in the result set, or -1 if this control is using a target assertion.

hasTargetOffset

boolean hasTargetOffset()

Returns true if this control is using a target offset, or false if this control is using a target assertion.

Returns:

true if this control is using a target offset, or false if this control is using a target assertion.