org.opends.server.admin.std.client
Interface LocalDBVLVIndexCfgClient

All Superinterfaces:
ConfigurationClient

public interface LocalDBVLVIndexCfgClient
extends ConfigurationClient

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

Local DB 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
 ManagedObjectDefinition<? extends LocalDBVLVIndexCfgClient,? extends LocalDBVLVIndexCfg> definition()
          Get the configuration definition associated with this Local DB VLV Index.
 DN getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getFilter()
          Gets the "filter" property.
 int getMaxBlockSize()
          Gets the "max-block-size" property.
 java.lang.String getName()
          Gets the "name" property.
 LocalDBVLVIndexCfgDefn.Scope getScope()
          Gets the "scope" property.
 java.lang.String getSortOrder()
          Gets the "sort-order" property.
 void setBaseDN(DN value)
          Sets the "base-dn" property.
 void setFilter(java.lang.String value)
          Sets the "filter" property.
 void setMaxBlockSize(java.lang.Integer value)
          Sets the "max-block-size" property.
 void setName(java.lang.String value)
          Sets the "name" property.
 void setScope(LocalDBVLVIndexCfgDefn.Scope value)
          Sets the "scope" property.
 void setSortOrder(java.lang.String value)
          Sets the "sort-order" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends LocalDBVLVIndexCfgClient,? extends LocalDBVLVIndexCfg> definition()
Get the configuration definition associated with this Local DB VLV Index.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Local DB 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 IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getFilter

java.lang.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(java.lang.String value)
               throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getMaxBlockSize

int getMaxBlockSize()
Gets the "max-block-size" property.

Specifies the number of entry IDs to store in a single sorted set before it must be split.

Returns:
Returns the value of the "max-block-size" property.

setMaxBlockSize

void setMaxBlockSize(java.lang.Integer value)
                     throws IllegalPropertyValueException,
                            PropertyIsReadOnlyException
Sets the "max-block-size" property.

Specifies the number of entry IDs to store in a single sorted set before it must be split.

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

Parameters:
value - The value of the "max-block-size" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Local DB VLV Index is not being initialized.

getName

java.lang.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(java.lang.String value)
             throws IllegalPropertyValueException,
                    PropertyIsReadOnlyException
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 Local DB VLV Index.

Parameters:
value - The value of the "name" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.
PropertyIsReadOnlyException - If this Local DB VLV Index is not being initialized.

getScope

LocalDBVLVIndexCfgDefn.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(LocalDBVLVIndexCfgDefn.Scope value)
              throws IllegalPropertyValueException
Sets the "scope" property.

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

Parameters:
value - The value of the "scope" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getSortOrder

java.lang.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(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.