1 /**
2 * Copyright 2005-2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 package org.kuali.rice.kim.api.role;
17
18 import org.kuali.rice.core.api.mo.common.GloballyUnique;
19 import org.kuali.rice.core.api.mo.common.Identifiable;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
22
23 /**
24 * Contract for a Role. Role is a basic abstraction over a role assignable to a principal within KIM.
25 */
26 public interface RoleContract extends Versioned, Identifiable, Inactivatable, GloballyUnique {
27
28 /**
29 * A namespace for this role. A namespace for a role identifies the system/module to which this role applies.
30 *
31 * @return Namespace for the role.
32 */
33 String getNamespaceCode();
34
35 /**
36 * The human readable name for this role.
37 *
38 * @return Human readable role name.
39 */
40 String getName();
41
42 /**
43 * A full textual description of this role. This String should provide a verbose description of the role, what
44 * it is meant to provide to principals assigned to it, and what permissions it implies.
45 *
46 * @return Description of the role.
47 */
48 String getDescription();
49
50 /**
51 * Provides the associated KimType identifier for this role. This controls what additional attributes
52 * are available.
53 *
54 * @return KimType Id
55 */
56 String getKimTypeId();
57 }