com.netscape.jndi.ldap.controls

Class LdapVirtualListResponseControl

Implemented Interfaces:
Control

public class LdapVirtualListResponseControl
extends LDAPVirtualListResponse
implements Control

Represents control data for returning paged results from a search.
      VirtualListViewResponse ::= SEQUENCE {
               firstPosition    INTEGER,
               contentCount     INTEGER,
               virtualListViewResult ENUMERATED {
                 success                  (0),
                 unwillingToPerform       (53),
                 insufficientAccessRights (50),
                 operationsError          (1),
                 busy                     (51),
                 timeLimitExceeded        (3),
                 adminLimitExceeded       (11),
                 sortControlMissing       (60),
                 indexRangeError          (?),
               }
     }

Method Summary

int
getContentCount()
Gets the size of the virtual result set.
byte[]
getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control.
int
getFirstPosition()
Gets the index of the first entry returned.
int
getResultCode()
Gets the result code.

Method Details

getContentCount

public int getContentCount()
Gets the size of the virtual result set.
Returns:
The size of the virtual result set, or -1 if not known.

getEncodedValue

public byte[] getEncodedValue()
Retrieves the ASN.1 BER encoded value of the LDAP control. Null is returned if the value is absent.
Returns:
A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.

getFirstPosition

public int getFirstPosition()
Gets the index of the first entry returned.
Returns:
The index of the first entry returned.

getResultCode

public int getResultCode()
Gets the result code.
Returns:
The result code.