|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.AbstractSchemaObject
org.apache.directory.shared.ldap.schema.DITStructureRule
public class DITStructureRule
A dITStructureRule definition. A dITStructureRules is a rule governing the structure of the DIT by specifying a permitted superior to subordinate entry relationship. A structure rule relates a nameForm, and therefore a STRUCTURAL objectClass, to superior dITStructureRules. This permits entries of the STRUCTURAL objectClass identified by the nameForm to exist in the DIT as subordinates to entries governed by the indicated superior dITStructureRules. Hence dITStructureRules only apply to structural object classes.
According to ldapbis [MODELS]:
DIT structure rule descriptions are written according to the ABNF: DITStructureRuleDescription = LPAREN WSP ruleid ; rule identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "FORM" SP oid ; NameForm [ SP "SUP" ruleids ] ; superior rules extensions WSP RPAREN ; extensions ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN ) ruleidlist = ruleid *( SP ruleid ) ruleid = number where: [ruleid] is the rule identifier of this DIT structure rule; NAME [qdescrs] are short names (descriptors) identifying this DIT structure rule; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this DIT structure rule use is not active; FORM is specifies the name form associated with this DIT structure rule; SUP identifies superior rules (by rule id); and [extensions] describe extensions. If no superior rules are identified, the DIT structure rule applies to an autonomous administrative point (e.g. the root vertex of the subtree controlled by the subschema) [X.501].
DescriptionUtils.getDescription(DITStructureRule)
,
Serialized FormField Summary |
---|
Fields inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
description, extensions, isEnabled, isObsolete, isReadOnly, locked, names, objectType, oid, schemaName, specification |
Constructor Summary | |
---|---|
DITStructureRule(int ruleId)
Creates a new instance of DITStructureRule |
Method Summary | |
---|---|
void |
addSuperRule(java.lang.Integer superRule)
Adds a new superior RuleId |
void |
clear()
Clear the current SchemaObject : remove all the references to other objects, and all the Maps. |
DITStructureRule |
copy()
Copy a DITStructureRule |
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getForm()
|
java.lang.String |
getOid()
The DSR does not have an OID, so throw an exception |
int |
getRuleId()
|
java.util.List<java.lang.Integer> |
getSuperRules()
|
void |
setForm(java.lang.String form)
Sets the associated NameForm's OID |
void |
setRuleId(int ruleId)
Sets the rule identifier of this DIT structure rule; |
void |
setSuperRules(java.util.List<java.lang.Integer> superRules)
Sets the list of superior RuleIds |
java.lang.String |
toString()
|
Methods inherited from class org.apache.directory.shared.ldap.schema.AbstractSchemaObject |
---|
addExtension, addName, addToRegistries, compareOid, copy, getDescription, getExtensions, getName, getNames, getObjectType, getSchemaName, getSpecification, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, registerOid, removeFromRegistries, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setRegistries, setSchemaName, setSpecification |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DITStructureRule(int ruleId)
Method Detail |
---|
public java.lang.String getForm()
public void setForm(java.lang.String form)
form
- The NameForm's OIDpublic int getRuleId()
public void setRuleId(int ruleId)
ruleId
- the rule identifier of this DIT structure rule;public java.util.List<java.lang.Integer> getSuperRules()
public void setSuperRules(java.util.List<java.lang.Integer> superRules)
superRules
- the list of superior RuleIdspublic void addSuperRule(java.lang.Integer superRule)
superRule
- The superior RuleID to addpublic java.lang.String getOid()
getOid
in interface SchemaObject
getOid
in class AbstractSchemaObject
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public DITStructureRule copy()
copy
in interface SchemaObject
copy
in class AbstractSchemaObject
public boolean equals(java.lang.Object o)
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object.equals(Object)
public void clear()
clear
in interface SchemaObject
clear
in class AbstractSchemaObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |