com.novell.admin.ns.ldap

Class StructureRules

java.lang.Object

com.novell.admin.ns.ldap.StructureRules

public class StructureRules
extends java.lang.Object

Represents a dITStructureRules element in the LDAP schema. dITStructureRules basically indicate the containment that is allowed for each class, although it's more flexible and complicated than in eDirectory. Defined in: draft-ietf-ldapbis-models-11.txt. StructureRules are specified by the "dITStructureRules" attribute in the LDAP schema object. StructureRules are an LDAP standard. Thay are not specified by the eDirectory schema, but are by Kepler.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get the description of the StructureRules.
java.lang.String	getName() Get the short name of the StructureRules.
java.lang.String	getNameForm() Get the getNameForm of the StructureRules.
java.lang.String	getRuleID() Get the ruleID of the StructureRules.
java.util.ArrayList	getSuperior() Get the Superior Structure Rules.
boolean	isObsolete() Indicates whether the StructureRules 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

StructureRules

public StructureRules(java.lang.String str)

Constructor for a StructureRules object.

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

Parameters:

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

Method Detail

getName

public java.lang.String getName()

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

Returns:

The short name of the StructureRules.

getDescription

public java.lang.String getDescription()

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

Returns:

The description of the StructureRules.

getRuleID

public java.lang.String getRuleID()

Get the ruleID of the StructureRules. This ID is required by the schema.

Returns:

The ruleID of the StructureRules.

getNameForm

public java.lang.String getNameForm()

Get the getNameForm of the StructureRules. This field is required by the schema.

Returns:

The NameForm of the StructureRules.

isObsolete

public boolean isObsolete()

Indicates whether the StructureRules has been specified as obsolete.

Returns:

true if the StructureRules is obsolete.

getSuperior

public java.util.ArrayList getSuperior()

Get the Superior Structure Rules. There must be at least one.

Returns:

The Superior Structure Rules.