org.opends.server.admin.std.client
Interface UserDefinedVirtualAttributeCfgClient

All Superinterfaces:
ConfigurationClient, VirtualAttributeCfgClient

public interface UserDefinedVirtualAttributeCfgClient
extends VirtualAttributeCfgClient

A client-side interface for reading and modifying User Defined Virtual Attribute settings.

The User Defined Virtual Attribute creates virtual attributes with user-defined values in entries that match the criteria defined in the plug-in's configuration.


Method Summary
 ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient,? extends UserDefinedVirtualAttributeCfg> definition()
          Get the configuration definition associated with this User Defined Virtual Attribute.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<java.lang.String> getValue()
          Gets the "value" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setValue(java.util.Collection<java.lang.String> values)
          Sets the "value" property.
 
Methods inherited from interface org.opends.server.admin.std.client.VirtualAttributeCfgClient
getAttributeType, getBaseDN, getConflictBehavior, getFilter, getGroupDN, isEnabled, setAttributeType, setBaseDN, setConflictBehavior, setEnabled, setFilter, setGroupDN
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends UserDefinedVirtualAttributeCfgClient,? extends UserDefinedVirtualAttributeCfg> definition()
Get the configuration definition associated with this User Defined Virtual Attribute.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface VirtualAttributeCfgClient
Returns:
Returns the configuration definition associated with this User Defined Virtual Attribute.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.

Specified by:
getJavaClass in interface VirtualAttributeCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.

Specified by:
setJavaClass in interface VirtualAttributeCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getValue

java.util.SortedSet<java.lang.String> getValue()
Gets the "value" property.

Specifies the values to be included in the virtual attribute.

Returns:
Returns the values of the "value" property.

setValue

void setValue(java.util.Collection<java.lang.String> values)
              throws IllegalPropertyValueException
Sets the "value" property.

Specifies the values to be included in the virtual attribute.

Parameters:
values - The values of the "value" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.