1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.ldap.server.schema;
18
19
20 import org.apache.ldap.common.schema.NameForm;
21
22 import javax.naming.NamingException;
23 import java.util.Iterator;
24
25
26 /***
27 * An NameForm registry service interface.
28 *
29 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30 * @version $Rev: 159259 $
31 */
32 public interface NameFormRegistry
33 {
34 /***
35 * Registers a NameForm with this registry.
36 *
37 * @param schema the name of the schema the NameForm is associated with
38 * @param nameForm the nameForm to register
39 * @throws NamingException if the NameForm is already registered or the
40 * registration operation is not supported
41 */
42 void register( String schema, NameForm nameForm ) throws NamingException;
43
44 /***
45 * Looks up a nameForm by its unique Object Identifier or by name.
46 *
47 * @param id the object identifier or name
48 * @return the NameForm instance for the id
49 * @throws NamingException if the NameForm does not exist
50 */
51 NameForm lookup( String id ) throws NamingException;
52
53 /***
54 * Gets the name of the schema this schema object is associated with.
55 *
56 * @param id the object identifier or the name
57 * @return the schema name
58 * @throws NamingException if the schema object does not exist
59 */
60 String getSchemaName( String id ) throws NamingException;
61
62 /***
63 * Checks to see if an nameForm exists.
64 *
65 * @param id the object identifier or name
66 * @return true if an nameForm definition exists for the oid, false
67 * otherwise
68 */
69 boolean hasNameForm( String id );
70
71 /***
72 * Lists all the NameForms within this registry.
73 *
74 * @return an Iterator over all the NameForms within this registry
75 */
76 Iterator list();
77 }