Interface SchemaElement
-
- All Known Implementing Classes:
AttributeTypeHolder
,ObjectClassHolder
,SchemaElementImpl
public interface SchemaElement
An interface defining the methods to be implemented by the SchemaElement classes- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDescription()
List<String>
getExtension(String key)
Map<String,List<String>>
getExtensions()
List<String>
getNames()
String
getOid()
boolean
isObsolete()
Tells if the attributeType is obsoletevoid
setDescription(String description)
Set the schema element's descriptionvoid
setExtensions(Map<String,List<String>> extensions)
Set a list of extensions for a schemaElementvoid
setNames(List<String> names)
Set a list of names for a schemaElementvoid
setObsolete(boolean isObsolete)
Set the obsolete flagString
toLdif(String schemaName)
Generate a String representation of this schemaElement, formated as a ldif string
-
-
-
Method Detail
-
isObsolete
boolean isObsolete()
Tells if the attributeType is obsolete- Returns:
- true if the schema element is obsolete, folse otherwise
-
setObsolete
void setObsolete(boolean isObsolete)
Set the obsolete flag- Parameters:
isObsolete
- The value to be set
-
getDescription
String getDescription()
- Returns:
- Return the schema element description
-
setDescription
void setDescription(String description)
Set the schema element's description- Parameters:
description
- The schema element's description
-
setNames
void setNames(List<String> names)
Set a list of names for a schemaElement- Parameters:
names
- The list of names of this schemaElement
-
getExtensions
Map<String,List<String>> getExtensions()
- Returns:
- The list of extensions for the schemaElement
-
getExtension
List<String> getExtension(String key)
- Parameters:
key
- the Extension key- Returns:
- The list of a values for a given extension
-
setExtensions
void setExtensions(Map<String,List<String>> extensions)
Set a list of extensions for a schemaElement- Parameters:
extensions
- The list of extensions of this schemaElement
-
toLdif
String toLdif(String schemaName) throws LdapException
Generate a String representation of this schemaElement, formated as a ldif string- Parameters:
schemaName
- The schema from which is extracted this schemaElement- Returns:
- A string representing the schemaElement as a Ldif formated String
- Throws:
LdapException
- If any error occurs.
-
-