org.apache.directory.api.ldap.schema.converter

Interface SchemaElement

All Known Implementing Classes:

AttributeTypeHolder, ObjectClassHolder, SchemaElementImpl

public interface SchemaElement

An interface defining the methods to be implemented by the SchemaElement classes

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.util.List<java.lang.String>	getExtension(java.lang.String key)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getExtensions()
java.util.List<java.lang.String>	getNames()
java.lang.String	getOid() Returns the schema element's OID
boolean	isObsolete() Tells if the attributeType is obsolete
void	setDescription(java.lang.String description) Set the schema element's description
void	setExtensions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> extensions) Set a list of extensions for a schemaElement
void	setNames(java.util.List<java.lang.String> names) Set a list of names for a schemaElement
void	setObsolete(boolean isObsolete) Set the obsolete flag
java.lang.String	toLdif(java.lang.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

getOid

java.lang.String getOid()

Returns the schema element's OID

getDescription

java.lang.String getDescription()

Returns:

Return the schema element description

setDescription

void setDescription(java.lang.String description)

Set the schema element's description

Parameters:

description - The schema element's description

getNames

java.util.List<java.lang.String> getNames()

Returns:

The list of names for the schemaElement

setNames

void setNames(java.util.List<java.lang.String> names)

Set a list of names for a schemaElement

Parameters:

names - The list of names of this schemaElement

getExtensions

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExtensions()

Returns:

The list of extensions for the schemaElement

getExtension

java.util.List<java.lang.String> getExtension(java.lang.String key)

Parameters:

key - the Extension key

Returns:

The list of a values for a given extension

setExtensions

void setExtensions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> extensions)

Set a list of extensions for a schemaElement

Parameters:

extensions - The list of extensions of this schemaElement

toLdif

java.lang.String toLdif(java.lang.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.