src/main/java/org/apache/directory/fortress/core/model/Graphable.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */
package org.apache.directory.fortress.core.model;


import java.util.Set;


/**
 * The Fortress Graphable interface prescribes attributes that are used to maintain implementor within a simple directed 
 * graph. {@link org.apache.directory.fortress.core.model.Role}, {@link org.apache.directory.fortress.core.model.AdminRole}, 
 * {@link org.apache.directory.fortress.core.model.OrgUnit} entities.
 * <p>
 * <h3></h3>
 * <h4>Manageable Schema</h4>
 * The entity maps to Fortress LDAP attributetype :
 * <pre>
 * ( 1.3.6.1.4.1.1.38088.1.28
 *   NAME 'ftParents'
 *   DESC 'Fortress Parent Nodes'
 *   EQUALITY caseIgnoreMatch
 *   SUBSTR caseIgnoreSubstringsMatch
 *   SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )
 * </pre>
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface Graphable
{
    /**
     * Get the names of roles that are parents (direct ascendants) of this role.
     *
     * @return Set of parent role names assigned to this role.
     */
    Set<String> getParents();


    /**
     * Set the names of roles names that are parents (direct ascendants) of this role.
     *
     * @param parents contains the Set of parent role names assigned to this role.
     */
    void setParents( Set<String> parents );


    /**
     * Set the occupant attribute with the contents of the User dn.
     *
     * @param parent maps to 'ftParents' attribute on 'ftRls' object class.
     */
    void setParent( String parent );


    /**
     * Set the occupant attribute with the contents of the User dn.
     *
     * @param parent maps to 'ftParents' attribute on 'ftRls' object class.
     */
    void delParent( String parent );


    /**
     * Get the name required attribute of the node.
     *
     * @return attribute maps to attribute  on 'organizationalUnit' object class.
     */
    String getName();


    /**
     * Sets the required name attribute on the node.
     *
     * @param name The name to set
     */
    void setName( String name );
}