KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ldap > server > schema > AttributeTypeRegistry


1 /*
2  * Copyright 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */

17 package org.apache.ldap.server.schema;
18
19
20 import org.apache.ldap.common.schema.AttributeType;
21
22 import javax.naming.NamingException JavaDoc;
23 import java.util.Iterator JavaDoc;
24
25
26 /**
27  * An AttributeType registry service interface.
28  *
29  * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
30  * @version $Rev: 169198 $
31  */

32 public interface AttributeTypeRegistry
33 {
34     /**
35      * Registers a new AttributeType with this registry.
36      *
37      * @param schema the name of the schema the AttributeType is associated with
38      * @param attributeType the AttributeType to register
39      * @throws NamingException if the AttributeType is already registered or
40      * the registration operation is not supported
41      */

42     void register( String JavaDoc schema, AttributeType attributeType ) throws NamingException JavaDoc;
43     
44     /**
45      * Looks up an AttributeType by its unique Object Identifier or by its
46      * unique name.
47      *
48      * @param id the object identifier or name of the AttributeType
49      * @return the AttributeType instance for the oid
50      * @throws NamingException if the AttributeType does not exist
51      */

52     AttributeType lookup( String JavaDoc id ) throws NamingException JavaDoc;
53
54     /**
55      * Gets the name of the schema this schema object is associated with.
56      *
57      * @param id the object identifier or the name
58      * @return the schema name
59      * @throws NamingException if the schema object does not exist
60      */

61     String JavaDoc getSchemaName( String JavaDoc id ) throws NamingException JavaDoc;
62
63     /**
64      * Checks to see if an AttributeType exists.
65      *
66      * @param id the object identifier or name of the AttributeType
67      * @return true if an AttributeType definition exists for the oid, false
68      * otherwise
69      */

70     boolean hasAttributeType( String JavaDoc id );
71
72     /**
73      * Gets an Iterator over the AttributeTypes within this registry.
74      *
75      * @return an iterator over all AttributeTypes in registry
76      */

77     Iterator JavaDoc list();
78 }
79
Popular Tags