|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SchemaObject
Most schema objects have some common attributes. This class
contains the minimum set of properties exposed by a SchemaObject.
We have 11 types of SchemaObjects :
Method Summary | |
---|---|
void |
addExtension(java.lang.String key,
java.util.List<java.lang.String> values)
Add an extension with its values |
void |
addName(java.lang.String... names)
Add a new name to the list of names for this SchemaObject. |
void |
addToRegistries(java.util.List<java.lang.Throwable> errors,
Registries registries)
Inject this SchemaObject into the given registries, updating the references to other SchemaObject |
void |
clear()
Clear the current SchemaObject : remove all the references to other objects, and all the Maps. |
SchemaObject |
copy()
Copy the current SchemaObject on place |
SchemaObject |
copy(SchemaObject original)
Copy a SchemaObject. |
boolean |
equals(java.lang.Object o1)
|
java.lang.String |
getDescription()
Gets a short description about this SchemaObject. |
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getExtensions()
|
java.lang.String |
getName()
Gets the first name in the set of short names for this SchemaObject if any exists for it. |
java.util.List<java.lang.String> |
getNames()
Gets short names for this SchemaObject if any exists for it, otherwise, returns an empty list. |
SchemaObjectType |
getObjectType()
The SchemaObject type : AttributeType DitCOntentRule DitStructureRule LdapComparator (specific to ADS) LdapSyntaxe MatchingRule MatchingRuleUse NameForm Normalizer (specific to ADS) ObjectClass SyntaxChecker (specific to ADS) |
java.lang.String |
getOid()
Gets usually what is the numeric object identifier assigned to this SchemaObject. |
java.lang.String |
getSchemaName()
Gets the name of the schema this SchemaObject is associated with. |
java.lang.String |
getSpecification()
Gets the SchemaObject specification. |
int |
hashCode()
|
boolean |
isDisabled()
Tells if this SchemaObject is disabled. |
boolean |
isEnabled()
Tells if this SchemaObject is enabled. |
boolean |
isObsolete()
Gets whether or not this SchemaObject has been inactivated. |
boolean |
isReadOnly()
Tells if this SchemaObject is ReadOnly. |
void |
lock()
Transform the SchemaObject to an immutable object TODO locked. |
void |
registerOid(SchemaObject schemaObject,
Registries registries)
Register the given SchemaObject into the given registries' globalOidRegistry |
void |
removeFromRegistries(java.util.List<java.lang.Throwable> errors,
Registries registries)
Remove this SchemaObject from the given registries, updating the references to other SchemaObject |
void |
setDescription(java.lang.String description)
Sets the SchemaObject's description |
void |
setEnabled(boolean enabled)
Sets the SchemaObject state, either enabled or disabled. |
void |
setExtensions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> extensions)
Add an extensions with their values. |
void |
setNames(java.util.List<java.lang.String> names)
Sets the list of names for this SchemaObject. |
void |
setObsolete(boolean obsolete)
Sets the Obsolete flag. |
void |
setOid(java.lang.String oid)
A special method used when renaming an SchemaObject: we may have to change it's OID |
void |
setReadOnly(boolean isReadOnly)
Sets the SchemaObject readOnly flag |
void |
setRegistries(Registries registries)
Inject the Registries into the SchemaObject |
void |
setSchemaName(java.lang.String schemaName)
Sets the name of the schema this SchemaObject is associated with. |
void |
setSpecification(java.lang.String specification)
Sets the SchemaObject's specification |
Method Detail |
---|
java.lang.String getOid()
void setOid(java.lang.String oid)
oid
- The new OIDjava.util.List<java.lang.String> getNames()
java.lang.String getName()
void addToRegistries(java.util.List<java.lang.Throwable> errors, Registries registries) throws LdapException
errors
- The errors we gotregistries
- The Registries
LdapException
void removeFromRegistries(java.util.List<java.lang.Throwable> errors, Registries registries) throws LdapException
errors
- The errors we gotregistries
- The Registries
LdapException
void addName(java.lang.String... names)
names
- The names to addvoid setNames(java.util.List<java.lang.String> names)
names
- The list of names. Can be emptyjava.lang.String getDescription()
void setDescription(java.lang.String description)
description
- The SchemaObject's descriptionjava.lang.String getSpecification()
void setSpecification(java.lang.String specification)
specification
- The SchemaObject's specificationboolean isEnabled()
schemaEnabled
- the associated schema status
boolean isDisabled()
void setEnabled(boolean enabled)
enabled
- The current SchemaObject stateboolean isReadOnly()
void setReadOnly(boolean isReadOnly)
enabled
- The current SchemaObject ReadOnly statusboolean isObsolete()
void setObsolete(boolean obsolete)
obsolete
- The Obsolete flag statejava.util.Map<java.lang.String,java.util.List<java.lang.String>> getExtensions()
void addExtension(java.lang.String key, java.util.List<java.lang.String> values)
key
- The extension keyvalues
- The associated valuesvoid setExtensions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> extensions)
key
- The extension keyvalues
- The associated valuesSchemaObjectType getObjectType()
java.lang.String getSchemaName()
void setSchemaName(java.lang.String schemaName)
schemaName
- the new schema nameint hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
boolean equals(java.lang.Object o1)
equals
in class java.lang.Object
Object.equals(Object)
void registerOid(SchemaObject schemaObject, Registries registries) throws LdapException
schemaObject
- the SchemaObject we want to registerregistries
- The registries in which we want it to be stored
LdapException
- If the OID is invalidSchemaObject copy()
SchemaObject copy(SchemaObject original)
void clear()
void setRegistries(Registries registries)
registries
- The Registriesvoid lock()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |