Package netscape.ldap.controls

Class LDAPVirtualListControl

java.lang.Object

netscape.ldap.LDAPControl

netscape.ldap.controls.LDAPVirtualListControl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LDAPVirtualListControl
extends LDAPControl

Represents control data for returning paged results from a search. Example of usage, with JFC:

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VIRTUALLIST

Fields inherited from class netscape.ldap.LDAPControl

m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING

Constructor Summary

Constructors

Constructor	Description
LDAPVirtualListControl(int startIndex, int beforeCount, int afterCount, int contentCount)	Constructs a new LDAPVirtualListControl object.
LDAPVirtualListControl(int startIndex, int beforeCount, int afterCount, int contentCount, java.lang.String context)
LDAPVirtualListControl(java.lang.String jumpTo, int beforeCount, int afterCount)	Constructs a new LDAPVirtualListControl object.
LDAPVirtualListControl(java.lang.String jumpTo, int beforeCount, int afterCount, java.lang.String context)

Method Summary

Modifier and Type	Method	Description
int	getAfterCount()	Gets the number of results after the top/center to return per page.
int	getBeforeCount()	Gets the number of results before the top/center to return per page.
java.lang.String	getContext()	Gets the optional context cookie.
int	getIndex()	Gets the size of the virtual result set.
int	getListSize()	Gets the size of the virtual result set.
void	setContext(java.lang.String context)	Sets the optional context cookie.
void	setListSize(int listSize)	Sets the size of the virtual result set.
void	setRange(int startIndex, int beforeCount, int afterCount)	Sets the starting index, and the number of entries before and after to return.
void	setRange(java.lang.String jumpTo, int beforeCount, int afterCount)	Sets the search expression, and the number of entries before and after to return.
java.lang.String	toString()	Return a string representation of the control for debugging

Methods inherited from class netscape.ldap.LDAPControl

clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register

Methods inherited from class java.lang.Object

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

Field Detail

VIRTUALLIST

public static final java.lang.String VIRTUALLIST

See Also:

Constant Field Values

Constructor Detail

LDAPVirtualListControl

public LDAPVirtualListControl(java.lang.String jumpTo,
                              int beforeCount,
                              int afterCount)

Constructs a new LDAPVirtualListControl object. Use this constructor on an initial search operation, specifying the first entry to be matched, or the initial part of it.

Parameters:

jumpTo - an LDAP search expression defining the result set

beforeCount - the number of results before the top/center to return per page

afterCount - the number of results after the top/center to return per page

See Also:

LDAPControl

LDAPVirtualListControl

public LDAPVirtualListControl(java.lang.String jumpTo,
                              int beforeCount,
                              int afterCount,
                              java.lang.String context)

LDAPVirtualListControl

public LDAPVirtualListControl(int startIndex,
                              int beforeCount,
                              int afterCount,
                              int contentCount)

Constructs a new LDAPVirtualListControl object. Use this constructor on a subsquent search operation, after we know the size of the virtual list, to fetch a subset.

Parameters:

startIndex - the index into the virtual list of an entry to return

beforeCount - the number of results before the top/center to return per page

afterCount - the number of results after the top/center to return per page

See Also:

LDAPControl

LDAPVirtualListControl

public LDAPVirtualListControl(int startIndex,
                              int beforeCount,
                              int afterCount,
                              int contentCount,
                              java.lang.String context)

Method Detail

setRange

public void setRange(int startIndex,
                     int beforeCount,
                     int afterCount)

Sets the starting index, and the number of entries before and after to return. Apply this method to a control returned from a previous search, to specify what result range to return on the next search.

Parameters:

startIndex - the index into the virtual list of an entry to return

beforeCount - the number of results before startIndex to return per page

afterCount - the number of results after startIndex to return per page

See Also:

LDAPControl

setRange

public void setRange(java.lang.String jumpTo,
                     int beforeCount,
                     int afterCount)

Sets the search expression, and the number of entries before and after to return.

Parameters:

jumpTo - an LDAP search expression defining the result set return.

beforeCount - the number of results before startIndex to return per page

afterCount - the number of results after startIndex to return per page

See Also:

LDAPControl

getIndex

public int getIndex()

Gets the size of the virtual result set.

Returns:

the size of the virtual result set, or -1 if not known.

getListSize

public int getListSize()

Gets the size of the virtual result set.

Returns:

the size of the virtual result set, or -1 if not known.

setListSize

public void setListSize(int listSize)

Sets the size of the virtual result set.

Parameters:

listSize - the virtual result set size

getBeforeCount

public int getBeforeCount()

Gets the number of results before the top/center to return per page.

Returns:

the number of results before the top/center to return per page.

getAfterCount

public int getAfterCount()

Gets the number of results after the top/center to return per page.

Returns:

the number of results after the top/center to return per page.

getContext

public java.lang.String getContext()

Gets the optional context cookie.

Returns:

the optional context cookie.

setContext

public void setContext(java.lang.String context)

Sets the optional context cookie.

Parameters:

context - the optional context cookie

toString

public java.lang.String toString()

Description copied from class: LDAPControl

Return a string representation of the control for debugging

Overrides:

toString in class LDAPControl

Returns:

a string representation of the control.