NameForm (UnboundID Server SDK)

```
@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface NameForm
```
This interface defines a set of methods that may be used to obtain information about a name form 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 name form.
`java.lang.String`	`getDescription()` Retrieves the description for this name form, if any.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getExtensions()` Retrieves a map of all defined extensions for this name form.
`java.lang.String`	`getNameOrOID()` Retrieves the primary name for this name form, or the numeric OID if no names are defined.
`java.util.List<java.lang.String>`	`getNames()` Retrieves the list of names for this name form, if any.
`java.lang.String`	`getOID()` Retrieves the numeric OID for this name form.
`java.util.Set<AttributeType>`	`getOptionalAttributes()` Retrieves the set of optional attributes for this name form, if any.
`java.util.Set<AttributeType>`	`getRequiredAttributes()` Retrieves the set of required attributes for this name form.
`java.lang.String`	`getSchemaFileName()` Retrieves the name of the schema file in which this name form is defined.
`ObjectClass`	`getStructuralClass()` Retrieves the structural object class for this name form.
`int`	`hashCode()` Retrieves a hash code for this name form.
`boolean`	`hasNameOrOID(java.lang.String name)` Indicates whether the provided string is equal to the OID or any of the defined names for this name form.
`boolean`	`isObsolete()` Indicates whether this name form is declared obsolete in the server schema.
`boolean`	`isOptional(AttributeType t)` Indicates whether the provided attribute type is optional for this name form.
`boolean`	`isRequired(AttributeType t)` Indicates whether the provided attribute type is required by this name form.
`boolean`	`isRequiredOrOptional(AttributeType t)` Indicates whether the provided attribute type is allowed for use with this name form as either a required or optional type.
`java.lang.String`	`toString()` Retrieves a string representation of this name form definition.

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

Interface NameForm

Method Summary

Method Detail

getOID

getNames

getNameOrOID

hasNameOrOID

getDescription

getStructuralClass

getRequiredAttributes

isRequired

getOptionalAttributes

isOptional

isRequiredOrOptional

isObsolete

getExtensions

getSchemaFileName

equals

hashCode

toString