001    /**
002     * Copyright 2005-2014 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kim.api.role;
017    
018    import org.kuali.rice.core.api.mo.common.GloballyUnique;
019    import org.kuali.rice.core.api.mo.common.Identifiable;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    import org.kuali.rice.core.api.mo.common.active.Inactivatable;
022    
023    /**
024     * Contract for a Role. Role is a basic abstraction over a role assignable to a principal within KIM.
025     */
026    public interface RoleContract extends Versioned, Identifiable, Inactivatable, GloballyUnique {
027    
028        /**
029         * A namespace for this role.  A namespace for a role identifies the system/module to which this role applies.
030         *
031         * @return Namespace for the role.
032         */
033        String getNamespaceCode();
034    
035        /**
036         * The human readable name for this role.
037         *
038         * @return Human readable role name.
039         */
040        String getName();
041    
042        /**
043         * A full textual description of this role.  This String should provide a verbose description of the role, what
044         * it is meant to provide to principals assigned to it, and what permissions it implies.
045         *
046         * @return Description of the role.
047         */
048        String getDescription();
049    
050        /**
051         * Provides the associated KimType identifier for this role.  This controls what additional attributes
052         * are available.
053         *
054         * @return KimType Id
055         */
056        String getKimTypeId();
057    }