com.novell.admin.ns.ldap

Class NameForm

java.lang.Object

com.novell.admin.ns.ldap.NameForm

public class NameForm
extends java.lang.Object

Represents a nameForm element in the LDAP schema. NameForms basically indicate the Naming Attributes that are allowed for each class. Defined in: draft-ietf-ldapbis-models-11.txt. NameForms are specified by the "nameForms" attribute in the LDAP schema object. NameForms are an LDAP standard. Thay are not specified by the eDirectory schema, but are by Kepler.

Constructor Summary

Constructors

Constructor and Description
NameForm(java.lang.String str) Constructor for a NameForm object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get the description of the NameForm.
java.util.ArrayList	getMay() Get the naming attributes that are optional.
java.util.ArrayList	getMust() Get the naming attributes that are required.
java.lang.String	getName() Get the short name of the NameForm.
java.lang.String	getObjectClass() Get the ObjectClass of the NameForm.
java.lang.String	getOID() Get the OID of the NameForm.
boolean	isObsolete() Indicates whether the NameForm has been specified as obsolete.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NameForm

public NameForm(java.lang.String str)

Constructor for a NameForm object.

This constructor is called from LDAPSchemaImpl while reading and decoding the schema.

Parameters:

str - The nameFrom string value as reported by the LDAP schema.

Method Detail

getName

public java.lang.String getName()

Get the short name of the NameForm. The name is optional so null may be returned.

Returns:

The short name of the NameForm.

getDescription

public java.lang.String getDescription()

Get the description of the NameForm. This is an optional parameter so null may be returned.

Returns:

The description of the NameForm.

getOID

public java.lang.String getOID()

Get the OID of the NameForm. This OID is required by the schema.

Returns:

The OID of the NameForm.

getObjectClass

public java.lang.String getObjectClass()

Get the ObjectClass of the NameForm. This field is required by the schema.

Returns:

The ObjectClass of the NameForm.

isObsolete

public boolean isObsolete()

Indicates whether the NameForm has been specified as obsolete.

Returns:

true if the NameForm is obsolete.

getMust

public java.util.ArrayList getMust()

Get the naming attributes that are required. There must be at least one.

Returns:

The required naming attributes of the NameForm.

getMay

public java.util.ArrayList getMay()

Get the naming attributes that are optional. This is optional, so an empty ArrayList may be returned.

Returns:

The optional naming attributes of the NameForm.