1 /**
2 * Copyright 2005-2016 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.group;
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 import java.util.Map;
24 /**
25 * This is the contract for a Group. A group is a collection of principals. It's membership consists of direct principal
26 * assignment and/or nested group membership. All groups are uniquely identified by a namespace
27 * code plus a name.
28 *
29 *
30 * @author Kuali Rice Team (rice.collab@kuali.org)
31 */
32
33 public interface GroupContract extends Versioned, GloballyUnique, Inactivatable, Identifiable {
34
35 /**
36 * This is the namespace code for the Group.
37 *
38 * <p>
39 * This is a namespace code assigned to a Group. Together with name, it makes up another unique identifier for Group
40 * </p>
41 *
42 * @return namespaceCode
43 */
44 String getNamespaceCode();
45
46 /**
47 * This is the name for the Group.
48 *
49 * <p>
50 * This is a name assigned to a Group. Together with NamespaceCode, it makes up another unique identifier for Group
51 * </p>
52 *
53 * @return name
54 */
55 String getName();
56
57 /**
58 * This a description for the Group.
59 *
60 * <p>
61 * This is a description assigned to a Group.
62 * </p>
63 *
64 * @return description
65 */
66 String getDescription();
67
68 /**
69 * This a Kim Type Id for the Group.
70 *
71 * <p>
72 * This links a Kim Type to the Group to allow custom types of Groups.
73 * </p>
74 *
75 * @return description
76 */
77 String getKimTypeId();
78
79 /**
80 * This is a set of Attributes for a Group.
81 *
82 * <p>
83 * This is a set of attributes which are key-label pairs that are defined by the Group's Kim Type.
84 * </p>
85 *
86 * @return attributes
87 */
88 Map<String, String> getAttributes();
89
90 }