org.ldaptive.control.util
Class VirtualListViewParams

java.lang.Object
  org.ldaptive.control.util.VirtualListViewParams

public class VirtualListViewParams
extends Object

Contains data required by the virtual list view operation.

Version:

$Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Field Summary

protected org.slf4j.Logger

logger Logger for this class.

Constructor Summary

VirtualListViewParams(int offset, int before, int after)
Creates a new virtual list view params.

VirtualListViewParams(String assertion, int before, int after)
Creates a new virtual list view params.

Method Summary

VirtualListViewRequestControl	createRequestControl(boolean critical) Creates a new virtual list view request control using the properties in this VLV params.
VirtualListViewRequestControl	createRequestControl(Response<SearchResult> response, boolean critical) Creates a new virtual list view request control using the properties in this VLV params.
int	getAfterCount() Returns the after count.
String	getAssertionValue() Returns the assertion value.
int	getBeforeCount() Returns the before count.
int	getTargetOffset() Returns the target offset.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected final org.slf4j.Logger logger

Logger for this class.

Constructor Detail

VirtualListViewParams

public VirtualListViewParams(int offset,
                             int before,
                             int after)

Creates a new virtual list view params.

Parameters:

offset - target offset

before - before count

after - after count

VirtualListViewParams

public VirtualListViewParams(String assertion,
                             int before,
                             int after)

Creates a new virtual list view params.

Parameters:

assertion - assertion value

before - before count

after - after count

Method Detail

getBeforeCount

public int getBeforeCount()

Returns the before count.

Returns:

before count

getAfterCount

public int getAfterCount()

Returns the after count.

Returns:

after count

getTargetOffset

public int getTargetOffset()

Returns the target offset.

Returns:

target offset

getAssertionValue

public String getAssertionValue()

Returns the assertion value.

Returns:

assertion value

createRequestControl

public VirtualListViewRequestControl createRequestControl(boolean critical)

Creates a new virtual list view request control using the properties in this VLV params.

Parameters:

critical - whether the returned control is critical

Returns:

virtual list view request control

createRequestControl

public VirtualListViewRequestControl createRequestControl(Response<SearchResult> response,
                                                          boolean critical)

Creates a new virtual list view request control using the properties in this VLV params. The supplied response is inspected and if it contains a VLV response control, it's contextID and/or content count will be passed into the created request control.

Parameters:

response - response of a previous VLV operation

critical - whether the returned control is critical

Returns:

virtual list view request control

toString

public String toString()

Overrides:

toString in class Object