org.apache.directory.server.schema.registries
Interface MatchingRuleRegistry

All Superinterfaces:
SchemaObjectRegistry
All Known Implementing Classes:
DefaultMatchingRuleRegistry

public interface MatchingRuleRegistry
extends SchemaObjectRegistry

A registry used to track system matchingRules.

Version:
$Rev: 499844 $
Author:
Apache Directory Project

Method Summary
 boolean hasMatchingRule(java.lang.String oid)
          Checks to see if a MatchingRule exists.
 java.util.Iterator<org.apache.directory.shared.ldap.schema.MatchingRule> iterator()
          Gets an Iterator over the MatchingRules within this registry.
 org.apache.directory.shared.ldap.schema.MatchingRule lookup(java.lang.String id)
          Looks up a MatchingRule by its unique Object Identifier or by name.
 void register(org.apache.directory.shared.ldap.schema.MatchingRule matchingRule)
          Registers a MatchingRule with this registry.
 
Methods inherited from interface org.apache.directory.server.schema.registries.SchemaObjectRegistry
getSchemaName, unregister
 

Method Detail

register

void register(org.apache.directory.shared.ldap.schema.MatchingRule matchingRule)
              throws javax.naming.NamingException
Registers a MatchingRule with this registry.

Parameters:
matchingRule - the MatchingRule to register
Throws:
javax.naming.NamingException - if the matchingRule is already registered or the registration operation is not supported

lookup

org.apache.directory.shared.ldap.schema.MatchingRule lookup(java.lang.String id)
                                                            throws javax.naming.NamingException
Looks up a MatchingRule by its unique Object Identifier or by name.

Parameters:
id - the object identifier or the name identifier
Returns:
the MatchingRule for the id
Throws:
javax.naming.NamingException - if there is a backing store failure or the MatchingRule does not exist.

hasMatchingRule

boolean hasMatchingRule(java.lang.String oid)
Checks to see if a MatchingRule exists. Backing store failures simply return false.

Parameters:
oid - the object identifier
Returns:
true if a MatchingRule definition exists for the oid, false otherwise

iterator

java.util.Iterator<org.apache.directory.shared.ldap.schema.MatchingRule> iterator()
Gets an Iterator over the MatchingRules within this registry.

Specified by:
iterator in interface SchemaObjectRegistry
Returns:
an iterator over all MatchingRules in registry


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.