001/*
002 *   Licensed to the Apache Software Foundation (ASF) under one
003 *   or more contributor license agreements.  See the NOTICE file
004 *   distributed with this work for additional information
005 *   regarding copyright ownership.  The ASF licenses this file
006 *   to you under the Apache License, Version 2.0 (the
007 *   "License"); you may not use this file except in compliance
008 *   with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *   Unless required by applicable law or agreed to in writing,
013 *   software distributed under the License is distributed on an
014 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *   KIND, either express or implied.  See the License for the
016 *   specific language governing permissions and limitations
017 *   under the License.
018 *
019 */
020package org.apache.directory.server.core.api.administrative;
021
022
023import org.apache.directory.api.ldap.model.name.Dn;
024import org.apache.directory.api.ldap.model.subtree.AdministrativeRole;
025
026
027/**
028 * An interface used to describe an AdministrativePoint. An AdministrativePoint 
029 * holds some elements useful to navigate through the administrative model :
030 * <ul>
031 * <li>The Dn : the AP position in the DIT</li>
032 * <li>The UUID : The AP unique identifier used when an entry point to the AP it depends on</li>
033 * <li>The role : the AP role</li>
034 * <li>The parent : the AP this AP is the direct descendant of</li>
035 * </ul>
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 */
038public interface AdministrativePoint
039{
040    /**
041     * @return The AdministrativePoint Dn
042     */
043    Dn getDn();
044
045
046    /**
047     * @return The AdministrativePoint UUID
048     */
049    String getUuid();
050
051
052    /**
053     * Tells if the AdministrativePoint defines an autonomous area
054     * 
055     * @return true if the AdministrativePoint is an AutonomousArea
056     */
057    boolean isAutonomous();
058
059
060    /**
061     * Tells if the AdministrativePoint defines a inner area
062     * 
063     * @return true if the AdministrativePoint is an InnerArea
064     */
065    boolean isInner();
066
067
068    /**
069     * Tells if the AdministrativePoint defines a specific area
070     * 
071     * @return true if the AdministrativePoint is a SpecificArea
072     */
073    boolean isSpecific();
074
075
076    /**
077     * @return The parent AdministrativePoint, if any
078     */
079    AdministrativePoint getParent();
080
081
082    /**
083     * Set the AdministrativePoint parent
084     *
085     * @param parent the AdministrativePoint parent
086     */
087    void setParent( AdministrativePoint parent );
088
089
090    /**
091     * @return The administrativeRole
092     */
093    AdministrativeRole getRole();
094}