public interface BackendVlvIndexCfgClient extends ConfigurationClient
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.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends BackendVlvIndexCfgClient,? extends BackendVlvIndexCfg> |
definition()
Get the configuration definition associated with this Backend VLV Index.
|
ValueOrExpression<Dn> |
getBaseDn()
Gets the "base-dn" property.
|
ValueOrExpression<String> |
getFilter()
Gets the "filter" property.
|
ValueOrExpression<String> |
getName()
Gets the "name" property.
|
ValueOrExpression<BackendVlvIndexCfgDefn.Scope> |
getScope()
Gets the "scope" property.
|
ValueOrExpression<String> |
getSortOrder()
Gets the "sort-order" property.
|
void |
setBaseDn(ValueOrExpression<Dn> value)
Sets the "base-dn" property.
|
void |
setFilter(ValueOrExpression<String> value)
Sets the "filter" property.
|
void |
setName(ValueOrExpression<String> value)
Sets the "name" property.
|
void |
setScope(ValueOrExpression<BackendVlvIndexCfgDefn.Scope> value)
Sets the "scope" property.
|
void |
setSortOrder(ValueOrExpression<String> value)
Sets the "sort-order" property.
|
commit, properties
ManagedObjectDefinition<? extends BackendVlvIndexCfgClient,? extends BackendVlvIndexCfg> definition()
definition
in interface ConfigurationClient
ValueOrExpression<Dn> getBaseDn()
Specifies the base DN used in the search query that is being indexed.
void setBaseDn(ValueOrExpression<Dn> value) throws PropertyException
Specifies the base DN used in the search query that is being indexed.
value
- The value of the "base-dn" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getFilter()
Specifies the LDAP filter used in the query that is being indexed.
void setFilter(ValueOrExpression<String> value) throws PropertyException
Specifies the LDAP filter used in the query that is being indexed.
value
- The value of the "filter" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getName()
Specifies a unique name for this VLV index.
void setName(ValueOrExpression<String> value) throws PropertyException, PropertyException
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.
value
- The value of the "name" property.PropertyException
- If the new value is invalid.PropertyException
- If this Backend VLV Index is not being initialized.ValueOrExpression<BackendVlvIndexCfgDefn.Scope> getScope()
Specifies the LDAP scope of the query that is being indexed.
void setScope(ValueOrExpression<BackendVlvIndexCfgDefn.Scope> value) throws PropertyException
Specifies the LDAP scope of the query that is being indexed.
value
- The value of the "scope" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getSortOrder()
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.
void setSortOrder(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "sort-order" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.