org.opends.server.admin.std.client

Interface BackendVLVIndexCfgClient

All Superinterfaces:

ConfigurationClient

public interface BackendVLVIndexCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Backend VLV Index settings.

Backend VLV Indexes are used to store information about a specific search request that makes it possible to efficiently process them using the VLV control.

Method Summary

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends BackendVLVIndexCfgClient,? extends BackendVLVIndexCfg>	definition() Get the configuration definition associated with this Backend VLV Index.
DN	getBaseDN() Gets the "base-dn" property.
String	getFilter() Gets the "filter" property.
String	getName() Gets the "name" property.
BackendVLVIndexCfgDefn.Scope	getScope() Gets the "scope" property.
String	getSortOrder() Gets the "sort-order" property.
void	setBaseDN(DN value) Sets the "base-dn" property.
void	setFilter(String value) Sets the "filter" property.
void	setName(String value) Sets the "name" property.
void	setScope(BackendVLVIndexCfgDefn.Scope value) Sets the "scope" property.
void	setSortOrder(String value) Sets the "sort-order" property.

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends BackendVLVIndexCfgClient,? extends BackendVLVIndexCfg> definition()

Get the configuration definition associated with this Backend VLV Index.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Backend VLV Index.

getBaseDN

DN getBaseDN()

Gets the "base-dn" property.

Specifies the base DN used in the search query that is being indexed.

Returns:

Returns the value of the "base-dn" property.

setBaseDN

void setBaseDN(DN value)
               throws PropertyException

Sets the "base-dn" property.

Specifies the base DN used in the search query that is being indexed.

Parameters:

value - The value of the "base-dn" property.

Throws:

PropertyException - If the new value is invalid.

getFilter

String getFilter()

Gets the "filter" property.

Specifies the LDAP filter used in the query that is being indexed.

Returns:

Returns the value of the "filter" property.

setFilter

void setFilter(String value)
               throws PropertyException

Sets the "filter" property.

Specifies the LDAP filter used in the query that is being indexed.

Parameters:

value - The value of the "filter" property.

Throws:

PropertyException - If the new value is invalid.

getName

String getName()

Gets the "name" property.

Specifies a unique name for this VLV index.

Returns:

Returns the value of the "name" property.

setName

void setName(String value)
             throws PropertyException,
                    PropertyException

Sets the "name" property.

Specifies a unique name for this VLV index.

This property is read-only and can only be modified during creation of a Backend VLV Index.

Parameters:

value - The value of the "name" property.

Throws:

PropertyException - If the new value is invalid.

PropertyException - If this Backend VLV Index is not being initialized.

getScope

BackendVLVIndexCfgDefn.Scope getScope()

Gets the "scope" property.

Specifies the LDAP scope of the query that is being indexed.

Returns:

Returns the value of the "scope" property.

setScope

void setScope(BackendVLVIndexCfgDefn.Scope value)
              throws PropertyException

Sets the "scope" property.

Specifies the LDAP scope of the query that is being indexed.

Parameters:

value - The value of the "scope" property.

Throws:

PropertyException - If the new value is invalid.

getSortOrder

String getSortOrder()

Gets the "sort-order" property.

Specifies the names of the attributes that are used to sort the entries for the query being indexed.

Multiple attributes can be used to determine the sort order by listing the attribute names from highest to lowest precedence. Optionally, + or - can be prefixed to the attribute name to sort the attribute in ascending order or descending order respectively.

Returns:

Returns the value of the "sort-order" property.

setSortOrder

void setSortOrder(String value)
                  throws PropertyException

Sets the "sort-order" property.

Specifies the names of the attributes that are used to sort the entries for the query being indexed.

Multiple attributes can be used to determine the sort order by listing the attribute names from highest to lowest precedence. Optionally, + or - can be prefixed to the attribute name to sort the attribute in ascending order or descending order respectively.

Parameters:

value - The value of the "sort-order" property.

Throws:

PropertyException - If the new value is invalid.