mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

matthew_swift
13.46.2007 79cb3d38939c48e71eb1d83592f61765d3983cf0
opends/tests/unit-tests-testng/src/server/org/opends/server/admin/TestChildCfgClient.java
@@ -28,81 +28,161 @@
import java.util.Collection;
import java.util.SortedSet;
import org.opends.server.admin.ConfigurationClient;
import org.opends.server.admin.IllegalPropertyValueException;
import org.opends.server.admin.ManagedObjectDefinition;
import org.opends.server.admin.PropertyIsReadOnlyException;
import org.opends.server.types.AttributeType;
import org.opends.server.types.DN;
/**
 * A sample client-side configuration interface for testing.
 * A client-side interface for reading and modifying Test Child
 * settings.
 * <p>
 * A configuration for testing components that are subordinate to a
 * parent component. It re-uses the virtual-attribute configuration
 * LDAP profile.
 */
public interface TestChildCfgClient extends ConfigurationClient {
  /**
   * {@inheritDoc}
   * Get the configuration definition associated with this Test Child.
   *
   * @return Returns the configuration definition associated with this Test Child.
   */
  ManagedObjectDefinition<? extends TestChildCfgClient, ? extends TestChildCfg> definition();
  /**
   * Get the "heartbeat-interval" property.
   * Get the "mandatory-boolean-property" property.
   * <p>
   * A mandatory boolean property.
   *
   * @return Returns the value of the "heartbeat-interval" property.
   * @return Returns the value of the "mandatory-boolean-property" property.
   */
  long getHeartbeatInterval();
  Boolean isMandatoryBooleanProperty();
  /**
   * Set the "heartbeat-interval" property.
   * Set the "mandatory-boolean-property" property.
   * <p>
   * A mandatory boolean property.
   *
   * @param value
   *          The value of the "heartbeat-interval" property.
   * @param value The value of the "mandatory-boolean-property" property.
   * @throws IllegalPropertyValueException
   *           If the new value is invalid.
   */
  void setHeartbeatInterval(Long value) throws IllegalPropertyValueException;
  void setMandatoryBooleanProperty(boolean value) throws IllegalPropertyValueException;
  /**
   * Get the "maximum-length" property.
   * Get the "mandatory-class-property" property.
   * <p>
   * A mandatory Java-class property requiring a component restart.
   *
   * @return Returns the value of the "maximum-length" property.
   * @return Returns the value of the "mandatory-class-property" property.
   */
  int getMaximumLength();
  String getMandatoryClassProperty();
  /**
   * Set the "maximum-length" property.
   * Set the "mandatory-class-property" property.
   * <p>
   * A mandatory Java-class property requiring a component restart.
   *
   * @param value
   *          The value of the "maximum-length" property.
   * @param value The value of the "mandatory-class-property" property.
   * @throws IllegalPropertyValueException
   *           If the new value is invalid.
   */
  void setMaximumLength(Integer value) throws IllegalPropertyValueException;
  void setMandatoryClassProperty(String value) throws IllegalPropertyValueException;
  /**
   * Get the "minimum-length" property.
   * Get the "mandatory-read-only-attribute-type-property" property.
   * <p>
   * A mandatory read-only attribute type property.
   *
   * @return Returns the value of the "minimum-length" property.
   * @return Returns the value of the "mandatory-read-only-attribute-type-property" property.
   */
  int getMinimumLength();
  AttributeType getMandatoryReadOnlyAttributeTypeProperty();
  /**
   * Set the "minimum-length" property.
   * Set the "mandatory-read-only-attribute-type-property" property.
   * <p>
   * A mandatory read-only attribute type property.
   * <p>
   * This property is read-only and can only be modified during
   * creation of a Test Child.
   *
   * @param value
   *          The value of the "minimum-length" property.
   * @param value The value of the "mandatory-read-only-attribute-type-property" property.
   * @throws IllegalPropertyValueException
   *           If the new value is invalid.
   * @throws PropertyIsReadOnlyException
   *           If this Test Child is not being initialized.
   */
  void setMinimumLength(Integer value) throws IllegalPropertyValueException;
  void setMandatoryReadOnlyAttributeTypeProperty(AttributeType value) throws IllegalPropertyValueException, PropertyIsReadOnlyException;
  /**
   * Get the "optional-multi-valued-dn-property1" property.
   * <p>
   * An optional multi-valued DN property which inherits its values
   * from optional-multi-valued-dn-property in the parent.
   *
   * @return Returns the values of the "optional-multi-valued-dn-property1" property.
   */
  SortedSet<DN> getOptionalMultiValuedDNProperty1();
  /**
   * Set the "optional-multi-valued-dn-property1" property.
   * <p>
   * An optional multi-valued DN property which inherits its values
   * from optional-multi-valued-dn-property in the parent.
   *
   * @param values The values of the "optional-multi-valued-dn-property1" property.
   * @throws IllegalPropertyValueException
   *           If one or more of the new values are invalid.
   */
  void setOptionalMultiValuedDNProperty1(Collection<DN> values) throws IllegalPropertyValueException;
  /**
   * Get the "optional-multi-valued-dn-property2" property.
   * <p>
   * An optional multi-valued DN property which inherits its values
   * from optional-multi-valued-dn-property1.
   *
   * @return Returns the values of the "optional-multi-valued-dn-property2" property.
   */
  SortedSet<DN> getOptionalMultiValuedDNProperty2();
  /**
   * Set the "optional-multi-valued-dn-property2" property.
   * <p>
   * An optional multi-valued DN property which inherits its values
   * from optional-multi-valued-dn-property1.
   *
   * @param values The values of the "optional-multi-valued-dn-property2" property.
   * @throws IllegalPropertyValueException
   *           If one or more of the new values are invalid.
   */
  void setOptionalMultiValuedDNProperty2(Collection<DN> values) throws IllegalPropertyValueException;
}