DITContentRule (UnboundID Server SDK)

```
@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface DITContentRule
```
This interface defines a set of methods that may be used to obtain information about a DIT content rule defined in the server schema.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Indicates whether the provided object is equal to this DIT content rule.
`java.util.Set<ObjectClass>`	`getAuxiliaryClasses()` Retrieves the set of allowed auxiliary classes for this DIT content rule, if any.
`java.lang.String`	`getDescription()` Retrieves the description for this DIT content rule, if any.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getExtensions()` Retrieves a map of all defined extensions for this DIT content rule.
`java.lang.String`	`getNameOrOID()` Retrieves the primary name for this DIT content rule, or the numeric OID of the structural object class no names are defined.
`java.util.List<java.lang.String>`	`getNames()` Retrieves the list of names for this DIT content rule, if any.
`java.util.Set<AttributeType>`	`getOptionalAttributes()` Retrieves the set of optional attributes for this DIT content rule, if any.
`java.util.Set<AttributeType>`	`getProhibitedAttributes()` Retrieves the set of prohibited attributes for this DIT content rule, if any.
`java.util.Set<AttributeType>`	`getRequiredAttributes()` Retrieves the set of required attributes for this DIT content rule, if any.
`java.lang.String`	`getSchemaFileName()` Retrieves the name of the schema file in which this DIT content rule is defined.
`ObjectClass`	`getStructuralClass()` Retrieves the structural object class for this DIT content rule.
`int`	`hashCode()` Retrieves a hash code for this DIT content rule.
`boolean`	`hasNameOrOID(java.lang.String name)` Indicates whether the provided string is equal to any of the defined names or the OID of the structural class for this DIT content rule.
`boolean`	`isObsolete()` Indicates whether this DIT content rule is declared obsolete in the server schema.
`boolean`	`isOptional(AttributeType t)` Indicates whether the provided attribute type is optional for this DIT content rule.
`boolean`	`isProhibited(AttributeType t)` Indicates whether the provided attribute type is prohibited for this DIT content rule.
`boolean`	`isRequired(AttributeType t)` Indicates whether the provided attribute type is required by this DIT content rule.
`boolean`	`isRequiredOrOptional(AttributeType t)` Indicates whether the provided attribute type is allowed for use with this DIT content rule as either a required or optional type.
`java.lang.String`	`toString()` Retrieves a string representation of this DIT content rule definition.

- Method Detail
  - getNames
```
java.util.List<java.lang.String> getNames()
```
    Retrieves the list of names for this DIT content rule, if any.
    
    Returns:
    
    The list of names for this DIT content rule, or an empty list if there are no user-defined names.
  - getNameOrOID
```
java.lang.String getNameOrOID()
```
    Retrieves the primary name for this DIT content rule, or the numeric OID of the structural object class no names are defined.
    
    Returns:
    
    The primary name or structural class OID for this DIT content rule.
  - hasNameOrOID
```
boolean hasNameOrOID(java.lang.String name)
```
    Indicates whether the provided string is equal to any of the defined names or the OID of the structural class for this DIT content rule.
    
    Parameters:
    
    name - The name for which to make the determination.
    
    Returns:
    
    true if the provided string matches one of the names or the structural class OID for this DIT content rule, or false if not.
  - getDescription
```
java.lang.String getDescription()
```
    Retrieves the description for this DIT content rule, if any.
    
    Returns:
    
    The description for this DIT content rule, or null if it does not have a description.
  - getStructuralClass
```
ObjectClass getStructuralClass()
```
    Retrieves the structural object class for this DIT content rule.
    
    Returns:
    
    The structural object class for this DIT content rule.
  - getAuxiliaryClasses
```
java.util.Set<ObjectClass> getAuxiliaryClasses()
```
    Retrieves the set of allowed auxiliary classes for this DIT content rule, if any.
    
    Returns:
    
    The set of allowed auxiliary classes for this DIT content rule, or an empty set if there are no associated auxiliary classes.
  - getRequiredAttributes
```
java.util.Set<AttributeType> getRequiredAttributes()
```
    Retrieves the set of required attributes for this DIT content rule, if any.
    
    Returns:
    
    The set of required attributes for this DIT content rule, or an empty list if there are no required attributes.
  - isRequired
```
boolean isRequired(AttributeType t)
```
    Indicates whether the provided attribute type is required by this DIT content rule.
    
    Parameters:
    
    t - The attribute type for which to make the determination.
    
    Returns:
    
    true if the provided attribute type is required by this DIT content rule, or false if not.
  - getOptionalAttributes
```
java.util.Set<AttributeType> getOptionalAttributes()
```
    Retrieves the set of optional attributes for this DIT content rule, if any.
    
    Returns:
    
    The set of optional attributes for this DIT content rule, or an empty set if there are no optional attributes.
  - isOptional
```
boolean isOptional(AttributeType t)
```
    Indicates whether the provided attribute type is optional for this DIT content rule.
    
    Parameters:
    
    t - The attribute type for which to make the determination.
    
    Returns:
    
    true if the provided attribute type is optional for this DIT content rule, or false if not.
  - isRequiredOrOptional
```
boolean isRequiredOrOptional(AttributeType t)
```
    Indicates whether the provided attribute type is allowed for use with this DIT content rule as either a required or optional type.
    
    Parameters:
    
    t - The attribute type for which to make the determination.
    
    Returns:
    
    true if the provided attribute type is allowed for use with this DIT content rule, or false if not.
  - getProhibitedAttributes
```
java.util.Set<AttributeType> getProhibitedAttributes()
```
    Retrieves the set of prohibited attributes for this DIT content rule, if any.
    
    Returns:
    
    The set of prohibited attributes for this DIT content rule, or an empty set if there are no prohibited attributes.
  - isProhibited
```
boolean isProhibited(AttributeType t)
```
    Indicates whether the provided attribute type is prohibited for this DIT content rule.
    
    Parameters:
    
    t - The attribute type for which to make the determination.
    
    Returns:
    
    true if the provided attribute type is prohibited for this DIT content rule, or false if not.
  - isObsolete
```
boolean isObsolete()
```
    Indicates whether this DIT content rule is declared obsolete in the server schema.
    
    Returns:
    
    true if this DIT content rule is declared obsolete in the server schema, or false if not.
  - getExtensions
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExtensions()
```
    Retrieves a map of all defined extensions for this DIT content rule.
    
    Returns:
    
    A map of all defined extensions for this DIT content rule.
  - getSchemaFileName
```
java.lang.String getSchemaFileName()
```
    Retrieves the name of the schema file in which this DIT content rule is defined.
    
    Returns:
    
    The name of the schema file in which this DIT content rule is defined.
  - equals
```
boolean equals(java.lang.Object o)
```
    Indicates whether the provided object is equal to this DIT content rule.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - The object for which to make the determination.
    
    Returns:
    
    true if the provided object is equal to this DIT content rule, or false if not.
  - hashCode
```
int hashCode()
```
    Retrieves a hash code for this DIT content rule.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    A hash code for this DIT content rule.
  - toString
```
java.lang.String toString()
```
    Retrieves a string representation of this DIT content rule definition.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this DIT content rule definition.

Interface DITContentRule

Method Summary

Method Detail

getNames

getNameOrOID

hasNameOrOID

getDescription

getStructuralClass

getAuxiliaryClasses

getRequiredAttributes

isRequired

getOptionalAttributes

isOptional

isRequiredOrOptional

getProhibitedAttributes

isProhibited

isObsolete

getExtensions

getSchemaFileName

equals

hashCode

toString