|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LocalDBVLVIndexCfgClient
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 |
---|
ManagedObjectDefinition<? extends LocalDBVLVIndexCfgClient,? extends LocalDBVLVIndexCfg> definition()
definition
in interface ConfigurationClient
DN getBaseDN()
Specifies the base DN used in the search query that is being indexed.
void setBaseDN(DN value) throws IllegalPropertyValueException
Specifies the base DN used in the search query that is being indexed.
value
- The value of the "base-dn" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getFilter()
Specifies the LDAP filter used in the query that is being indexed.
void setFilter(java.lang.String value) throws IllegalPropertyValueException
Specifies the LDAP filter used in the query that is being indexed.
value
- The value of the "filter" property.
IllegalPropertyValueException
- If the new value is invalid.int getMaxBlockSize()
Specifies the number of entry IDs to store in a single sorted set before it must be split.
void setMaxBlockSize(java.lang.Integer value) throws IllegalPropertyValueException, PropertyIsReadOnlyException
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.
value
- The value of the "max-block-size" property.
IllegalPropertyValueException
- If the new value is invalid.
PropertyIsReadOnlyException
- If this Local DB VLV Index is not being initialized.java.lang.String getName()
Specifies a unique name for this VLV index.
void setName(java.lang.String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException
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.
value
- The value of the "name" property.
IllegalPropertyValueException
- If the new value is invalid.
PropertyIsReadOnlyException
- If this Local DB VLV Index is not being initialized.LocalDBVLVIndexCfgDefn.Scope getScope()
Specifies the LDAP scope of the query that is being indexed.
void setScope(LocalDBVLVIndexCfgDefn.Scope value) throws IllegalPropertyValueException
Specifies the LDAP scope of the query that is being indexed.
value
- The value of the "scope" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.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(java.lang.String value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |