|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnetscape.ldap.LDAPControl
netscape.ldap.controls.LDAPVirtualListControl
com.netscape.jndi.ldap.controls.LdapVirtualListControl
public class LdapVirtualListControl
Represents control data for returning paged results from a search.
VirtualListViewRequest ::= SEQUENCE { beforeCount INTEGER, afterCount INTEGER, CHOICE { byIndex [0] SEQUENCE { index INTEGER, contentCount INTEGER } byFilter [1] jumpTo Substring }
Field Summary |
---|
Fields inherited from class netscape.ldap.controls.LDAPVirtualListControl |
---|
VIRTUALLIST |
Fields inherited from class netscape.ldap.LDAPControl |
---|
m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING |
Fields inherited from interface javax.naming.ldap.Control |
---|
CRITICAL, NONCRITICAL |
Constructor Summary | |
---|---|
LdapVirtualListControl(int startIndex,
int beforeCount,
int afterCount,
int contentCount)
Constructs a new LDAPVirtualListControl object. |
|
LdapVirtualListControl(java.lang.String jumpTo,
int beforeCount,
int afterCount)
Constructs a new LDAPVirtualListControl object. |
Method Summary | |
---|---|
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. |
byte[] |
getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control. |
int |
getIndex()
Gets the size of the virtual result set. |
int |
getListSize()
Gets the size of the virtual result set. |
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. |
Methods inherited from class netscape.ldap.controls.LDAPVirtualListControl |
---|
getContext, setContext, toString |
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 |
Methods inherited from interface javax.naming.ldap.Control |
---|
getID, isCritical |
Constructor Detail |
---|
public LdapVirtualListControl(java.lang.String jumpTo, int beforeCount, int afterCount)
LDAPVirtualListControl
object. Use this
constructor on an initial search operation, specifying the first
entry to be matched, or the initial part of it.
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.public LdapVirtualListControl(int startIndex, int beforeCount, int afterCount, int contentCount)
LDAPVirtualListControl
object. Use this
constructor on a subsquent search operation, after we know the
size of the virtual list, to fetch a subset.
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.Method Detail |
---|
public void setRange(int startIndex, int beforeCount, int afterCount)
setRange
in class netscape.ldap.controls.LDAPVirtualListControl
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.public void setRange(java.lang.String jumpTo, int beforeCount, int afterCount)
setRange
in class netscape.ldap.controls.LDAPVirtualListControl
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.public int getIndex()
getIndex
in class netscape.ldap.controls.LDAPVirtualListControl
public int getListSize()
getListSize
in class netscape.ldap.controls.LDAPVirtualListControl
public void setListSize(int listSize)
setListSize
in class netscape.ldap.controls.LDAPVirtualListControl
listSize
- The virtual result set size.public int getBeforeCount()
getBeforeCount
in class netscape.ldap.controls.LDAPVirtualListControl
public int getAfterCount()
getAfterCount
in class netscape.ldap.controls.LDAPVirtualListControl
public byte[] getEncodedValue()
getEncodedValue
in interface javax.naming.ldap.Control
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |