1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.server.core.api.administrative;
21
22
23 import org.apache.directory.api.ldap.model.name.Dn;
24 import org.apache.directory.api.ldap.model.subtree.AdministrativeRole;
25
26
27 /**
28 * An interface used to describe an AdministrativePoint. An AdministrativePoint
29 * holds some elements useful to navigate through the administrative model :
30 * <ul>
31 * <li>The Dn : the AP position in the DIT</li>
32 * <li>The UUID : The AP unique identifier used when an entry point to the AP it depends on</li>
33 * <li>The role : the AP role</li>
34 * <li>The parent : the AP this AP is the direct descendant of</li>
35 * </ul>
36 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37 */
38 public interface AdministrativePoint
39 {
40 /**
41 * @return The AdministrativePoint Dn
42 */
43 Dn getDn();
44
45
46 /**
47 * @return The AdministrativePoint UUID
48 */
49 String getUuid();
50
51
52 /**
53 * Tells if the AdministrativePoint defines an autonomous area
54 *
55 * @return true if the AdministrativePoint is an AutonomousArea
56 */
57 boolean isAutonomous();
58
59
60 /**
61 * Tells if the AdministrativePoint defines a inner area
62 *
63 * @return true if the AdministrativePoint is an InnerArea
64 */
65 boolean isInner();
66
67
68 /**
69 * Tells if the AdministrativePoint defines a specific area
70 *
71 * @return true if the AdministrativePoint is a SpecificArea
72 */
73 boolean isSpecific();
74
75
76 /**
77 * @return The parent AdministrativePoint, if any
78 */
79 AdministrativePoint getParent();
80
81
82 /**
83 * Set the AdministrativePoint parent
84 *
85 * @param parent the AdministrativePoint parent
86 */
87 void setParent( AdministrativePoint parent );
88
89
90 /**
91 * @return The administrativeRole
92 */
93 AdministrativeRole getRole();
94 }