C# Class Novell.Directory.Ldap.Controls.LdapVirtualListControl

LdapVirtualListControl is a Server Control used to specify that results from a search are to be returned in pages - which are subsets of the entire virtual result set. On success, an updated LdapVirtualListResponse object is returned as a response Control, containing information on the virtual list size and the actual first index. This object can then be used by the client with a new requested position or length and sent to the server to obtain a different segment of the virtual list.

Inheritance: Novell.Directory.Ldap.LdapControl

Mostrar archivo Open project: EventStore/csharp-ldap Class Usage Examples

Public Methods

Method	Description
LdapVirtualListControl ( System jumpTo, int beforeCount, int afterCount ) : System	Constructs a virtual list control using the specified filter expression. The expression specifies the first entry to be used for the virtual search results. The other two paramers are the number of entries before and after a located index to be returned.
LdapVirtualListControl ( System jumpTo, int beforeCount, int afterCount, System context ) : System	Constructs a virtual list control using the specified filter expression along with an optional server context. The expression specifies the first entry to be used for the virtual search results. The other two paramers are the number of entries before and after a located index to be returned.
LdapVirtualListControl ( int startIndex, int beforeCount, int afterCount, int contentCount ) : System	Use this constructor to fetch a subset when the size of the virtual list is known,
LdapVirtualListControl ( int startIndex, int beforeCount, int afterCount, int contentCount, System context ) : System	Use this constructor to fetch a subset when the size of the virtual list is known,
setRange ( System jumpTo, int beforeCount, int afterCount ) : void	Sets the center or starting list index to return, and the number of results before and after.
setRange ( int listIndex, int beforeCount, int afterCount ) : void	Sets the center or starting list index to return, and the number of results before and after.

Private Methods

Method	Description
BuildIndexedVLVRequest ( ) : void	Private method used to construct the ber encoded control Used only when using the Indexed mode of VLV Control
BuildTypedVLVRequest ( ) : void	Private method used to construct the ber encoded control Used only when using the typed mode of VLV Control.
LdapVirtualListControl ( ) : System

Method Details

LdapVirtualListControl() public method

Constructs a virtual list control using the specified filter expression. The expression specifies the first entry to be used for the virtual search results. The other two paramers are the number of entries before and after a located index to be returned.

public LdapVirtualListControl ( System jumpTo, int beforeCount, int afterCount ) : System
jumpTo	System	A search expression that defines the first /// element to be returned in the virtual search results. The filter /// expression in the search operation itself may be, for example, /// "objectclass=person" and the jumpTo expression in the virtual /// list control may be "cn=m*", to retrieve a subset of entries /// starting at or centered around those with a common name beginning /// with the letter "M". /// ///
beforeCount	int	The number of entries before startIndex (the /// reference entry) to be returned. /// ///
afterCount	int	The number of entries after startIndex to be /// returned. ///
return	System

LdapVirtualListControl() public method

Constructs a virtual list control using the specified filter expression along with an optional server context. The expression specifies the first entry to be used for the virtual search results. The other two paramers are the number of entries before and after a located index to be returned.

public LdapVirtualListControl ( System jumpTo, int beforeCount, int afterCount, System context ) : System
jumpTo	System	A search expression that defines the first /// element to be returned in the virtual search results. The filter /// expression in the search operation itself may be, for example, /// "objectclass=person" and the jumpTo expression in the virtual /// list control may be "cn=m*", to retrieve a subset of entries /// starting at or centered around those with a common name beginning /// with the letter "M". /// ///
beforeCount	int	The number of entries before startIndex (the /// reference entry) to be returned. /// ///
afterCount	int	The number of entries after startIndex to be /// returned. /// ///
context	System	Used by some implementations to process requests /// more efficiently. The context should be null on the first search, /// and thereafter it should be whatever was returned by the server in the /// virtual list response control. ///
return	System

LdapVirtualListControl() public method

Use this constructor to fetch a subset when the size of the virtual list is known,

public LdapVirtualListControl ( int startIndex, int beforeCount, int afterCount, int contentCount ) : System
startIndex	int	The index of the reference entry to be returned. /// ///
beforeCount	int	The number of entries before startIndex (the /// reference entry) to be returned. /// ///
afterCount	int	The number of entries after startIndex to be /// returned. /// ///
contentCount	int	The total number of entries assumed to be in the /// list. This is a number returned on a previous search, in the /// LdapVirtualListResponse. The server may use this number to adjust /// the returned subset offset. ///
return	System

LdapVirtualListControl() public method

Use this constructor to fetch a subset when the size of the virtual list is known,

public LdapVirtualListControl ( int startIndex, int beforeCount, int afterCount, int contentCount, System context ) : System
startIndex	int	The index of the reference entry to be /// returned. /// ///
beforeCount	int	The number of entries before startIndex (the /// reference entry) to be returned. /// ///
afterCount	int	The number of entries after startIndex to be /// returned. /// ///
contentCount	int	The total number of entries assumed to be in the /// list. This is a number returned on a previous search, in the /// LdapVirtualListResponse. The server may use this number to adjust /// the returned subset offset. /// ///
context	System	Used by some implementations to process requests /// more efficiently. The context should be null on the first search, /// and thereafter it should be whatever was returned by the server in the /// virtual list response control. ///
return	System

setRange() public method

Sets the center or starting list index to return, and the number of results before and after.

public setRange ( System jumpTo, int beforeCount, int afterCount ) : void
jumpTo	System	A search expression that defines the first /// element to be returned in the virtual search results. The filter /// expression in the search operation itself may be, for example, /// "objectclass=person" and the jumpTo expression in the virtual /// list control may be "cn=m*", to retrieve a subset of entries /// starting at or centered around those with a common name /// beginning with the letter "M". /// ///
beforeCount	int	The number of entries before "listIndex" to be /// returned. /// ///
afterCount	int	The number of entries after "listIndex" to be /// returned. ///
return	void

setRange() public method

Sets the center or starting list index to return, and the number of results before and after.

public setRange ( int listIndex, int beforeCount, int afterCount ) : void
listIndex	int	The center or starting list index to be /// returned. /// ///
beforeCount	int	The number of entries before "listIndex" to be /// returned. /// ///
afterCount	int	The number of entries after "listIndex" to be /// returned. ///
return	void