org.apache.directory.server.core.schema
Interface DITStructureRuleRegistry

All Known Implementing Classes:

BootstrapDitStructureRuleRegistry, GlobalDitStructureRuleRegistry

public interface DITStructureRuleRegistry

An DITStructureRule registry service interface.

Version:

$Rev: 434579 $

Author:

Apache Directory Project

Method Summary

java.lang.String	getSchemaName(java.lang.String id) Gets the name of the schema this schema object is associated with.
boolean	hasDITStructureRule(java.lang.String id) Checks to see if an dITStructureRule exists.
java.util.Iterator	list() Lists all the DITStructureRules within this registry.
org.apache.directory.shared.ldap.schema.DITStructureRule	lookup(java.lang.String id) Looks up an dITStructureRule by its unique Object IDentifier or by its name.
void	register(java.lang.String schema, org.apache.directory.shared.ldap.schema.DITStructureRule dITStructureRule) Registers a DITStructureRule with this registry.

Method Detail

register

void register(java.lang.String schema,
              org.apache.directory.shared.ldap.schema.DITStructureRule dITStructureRule)
              throws javax.naming.NamingException

Registers a DITStructureRule with this registry.

Parameters:

schema - the name of the schema the DITStructureRule is associated with

dITStructureRule - the dITStructureRule to register

Throws:

javax.naming.NamingException - if the DITStructureRule is already registered or the registration operation is not supported

lookup

org.apache.directory.shared.ldap.schema.DITStructureRule lookup(java.lang.String id)
                                                                throws javax.naming.NamingException

Looks up an dITStructureRule by its unique Object IDentifier or by its name.

Parameters:

id - the object identifier, or the name

Returns:

the DITStructureRule instance for the id

Throws:

javax.naming.NamingException - if the DITStructureRule does not exist

getSchemaName

java.lang.String getSchemaName(java.lang.String id)
                               throws javax.naming.NamingException

Gets the name of the schema this schema object is associated with.

Parameters:

id - the object identifier or the name

Returns:

the schema name

Throws:

javax.naming.NamingException - if the schema object does not exist

hasDITStructureRule

boolean hasDITStructureRule(java.lang.String id)

Checks to see if an dITStructureRule exists.

Parameters:

id - the object identifier, or the name

Returns:

true if an dITStructureRule definition exists for the id, false otherwise

list

java.util.Iterator list()

Lists all the DITStructureRules within this registry.

Returns:

an Iterator over all the DITStructureRules within this registry