001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import org.opends.server.admin.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.meta.BackendVLVIndexCfgDefn.Scope;
034import org.opends.server.admin.std.server.BackendVLVIndexCfg;
035import org.opends.server.types.DN;
036
037
038
039/**
040 * A client-side interface for reading and modifying Backend VLV Index
041 * settings.
042 * <p>
043 * Backend VLV Indexes are used to store information about a specific
044 * search request that makes it possible to efficiently process them
045 * using the VLV control.
046 */
047public interface BackendVLVIndexCfgClient extends ConfigurationClient {
048
049  /**
050   * Get the configuration definition associated with this Backend VLV Index.
051   *
052   * @return Returns the configuration definition associated with this Backend VLV Index.
053   */
054  ManagedObjectDefinition<? extends BackendVLVIndexCfgClient, ? extends BackendVLVIndexCfg> definition();
055
056
057
058  /**
059   * Gets the "base-dn" property.
060   * <p>
061   * Specifies the base DN used in the search query that is being
062   * indexed.
063   *
064   * @return Returns the value of the "base-dn" property.
065   */
066  DN getBaseDN();
067
068
069
070  /**
071   * Sets the "base-dn" property.
072   * <p>
073   * Specifies the base DN used in the search query that is being
074   * indexed.
075   *
076   * @param value The value of the "base-dn" property.
077   * @throws PropertyException
078   *           If the new value is invalid.
079   */
080  void setBaseDN(DN value) throws PropertyException;
081
082
083
084  /**
085   * Gets the "filter" property.
086   * <p>
087   * Specifies the LDAP filter used in the query that is being
088   * indexed.
089   *
090   * @return Returns the value of the "filter" property.
091   */
092  String getFilter();
093
094
095
096  /**
097   * Sets the "filter" property.
098   * <p>
099   * Specifies the LDAP filter used in the query that is being
100   * indexed.
101   *
102   * @param value The value of the "filter" property.
103   * @throws PropertyException
104   *           If the new value is invalid.
105   */
106  void setFilter(String value) throws PropertyException;
107
108
109
110  /**
111   * Gets the "name" property.
112   * <p>
113   * Specifies a unique name for this VLV index.
114   *
115   * @return Returns the value of the "name" property.
116   */
117  String getName();
118
119
120
121  /**
122   * Sets the "name" property.
123   * <p>
124   * Specifies a unique name for this VLV index.
125   * <p>
126   * This property is read-only and can only be modified during
127   * creation of a Backend VLV Index.
128   *
129   * @param value The value of the "name" property.
130   * @throws PropertyException
131   *           If the new value is invalid.
132   * @throws PropertyException
133   *           If this Backend VLV Index is not being initialized.
134   */
135  void setName(String value) throws PropertyException, PropertyException;
136
137
138
139  /**
140   * Gets the "scope" property.
141   * <p>
142   * Specifies the LDAP scope of the query that is being indexed.
143   *
144   * @return Returns the value of the "scope" property.
145   */
146  Scope getScope();
147
148
149
150  /**
151   * Sets the "scope" property.
152   * <p>
153   * Specifies the LDAP scope of the query that is being indexed.
154   *
155   * @param value The value of the "scope" property.
156   * @throws PropertyException
157   *           If the new value is invalid.
158   */
159  void setScope(Scope value) throws PropertyException;
160
161
162
163  /**
164   * Gets the "sort-order" property.
165   * <p>
166   * Specifies the names of the attributes that are used to sort the
167   * entries for the query being indexed.
168   * <p>
169   * Multiple attributes can be used to determine the sort order by
170   * listing the attribute names from highest to lowest precedence.
171   * Optionally, + or - can be prefixed to the attribute name to sort
172   * the attribute in ascending order or descending order respectively.
173   *
174   * @return Returns the value of the "sort-order" property.
175   */
176  String getSortOrder();
177
178
179
180  /**
181   * Sets the "sort-order" property.
182   * <p>
183   * Specifies the names of the attributes that are used to sort the
184   * entries for the query being indexed.
185   * <p>
186   * Multiple attributes can be used to determine the sort order by
187   * listing the attribute names from highest to lowest precedence.
188   * Optionally, + or - can be prefixed to the attribute name to sort
189   * the attribute in ascending order or descending order respectively.
190   *
191   * @param value The value of the "sort-order" property.
192   * @throws PropertyException
193   *           If the new value is invalid.
194   */
195  void setSortOrder(String value) throws PropertyException;
196
197}