Package org.forgerock.opendj.server.config.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 Details

    • 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

      @MandatoryProperty ValueOrExpression<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

      @MandatoryProperty void setBaseDn(ValueOrExpression<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

      @MandatoryProperty ValueOrExpression<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

      @MandatoryProperty void setFilter(ValueOrExpression<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

      @MandatoryProperty ValueOrExpression<String> getName()
      Gets the "name" property.

      Specifies a unique name for this VLV index.

      Returns:
      Returns the value of the "name" property.

    • setName

      @MandatoryProperty void setName(ValueOrExpression<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

      @MandatoryProperty ValueOrExpression<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

      @MandatoryProperty void setScope(ValueOrExpression<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

      @MandatoryProperty ValueOrExpression<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

      @MandatoryProperty void setSortOrder(ValueOrExpression<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.