001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.client;
017
018
019
020import org.forgerock.opendj.config.ManagedObjectDefinition;
021import org.forgerock.opendj.config.PropertyException;
022import org.forgerock.opendj.ldap.schema.AttributeType;
023import org.forgerock.opendj.server.config.meta.VirtualAttributeCfgDefn.ConflictBehavior;
024import org.forgerock.opendj.server.config.server.StructuralObjectClassVirtualAttributeCfg;
025
026
027
028/**
029 * A client-side interface for reading and modifying Structural Object
030 * Class Virtual Attribute settings.
031 * <p>
032 * The Structural Object Class Virtual Attribute generates a virtual
033 * attribute that specifies the structural object class with the schema
034 * definitions in effect for the entry. This attribute is defined in
035 * RFC 4512.
036 */
037public interface StructuralObjectClassVirtualAttributeCfgClient extends VirtualAttributeCfgClient {
038
039  /**
040   * Get the configuration definition associated with this Structural Object Class Virtual Attribute.
041   *
042   * @return Returns the configuration definition associated with this Structural Object Class Virtual Attribute.
043   */
044  ManagedObjectDefinition<? extends StructuralObjectClassVirtualAttributeCfgClient, ? extends StructuralObjectClassVirtualAttributeCfg> definition();
045
046
047
048  /**
049   * Gets the "attribute-type" property.
050   * <p>
051   * Specifies the attribute type for the attribute whose values are
052   * to be dynamically assigned by the virtual attribute.
053   *
054   * @return Returns the value of the "attribute-type" property.
055   */
056  AttributeType getAttributeType();
057
058
059
060  /**
061   * Sets the "attribute-type" property.
062   * <p>
063   * Specifies the attribute type for the attribute whose values are
064   * to be dynamically assigned by the virtual attribute.
065   *
066   * @param value The value of the "attribute-type" property.
067   * @throws PropertyException
068   *           If the new value is invalid.
069   */
070  void setAttributeType(AttributeType value) throws PropertyException;
071
072
073
074  /**
075   * Gets the "conflict-behavior" property.
076   * <p>
077   * Specifies the behavior that the server is to exhibit for entries
078   * that already contain one or more real values for the associated
079   * attribute.
080   *
081   * @return Returns the value of the "conflict-behavior" property.
082   */
083  ConflictBehavior getConflictBehavior();
084
085
086
087  /**
088   * Sets the "conflict-behavior" property.
089   * <p>
090   * Specifies the behavior that the server is to exhibit for entries
091   * that already contain one or more real values for the associated
092   * attribute.
093   *
094   * @param value The value of the "conflict-behavior" property.
095   * @throws PropertyException
096   *           If the new value is invalid.
097   */
098  void setConflictBehavior(ConflictBehavior value) throws PropertyException;
099
100
101
102  /**
103   * Gets the "java-class" property.
104   * <p>
105   * Specifies the fully-qualified name of the virtual attribute
106   * provider class that generates the attribute values.
107   *
108   * @return Returns the value of the "java-class" property.
109   */
110  String getJavaClass();
111
112
113
114  /**
115   * Sets the "java-class" property.
116   * <p>
117   * Specifies the fully-qualified name of the virtual attribute
118   * provider class that generates the attribute values.
119   *
120   * @param value The value of the "java-class" property.
121   * @throws PropertyException
122   *           If the new value is invalid.
123   */
124  void setJavaClass(String value) throws PropertyException;
125
126}