1 /**
2 * Copyright 2005-2012 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.membership.MemberType;
19 import org.kuali.rice.core.api.mo.common.GloballyUnique;
20 import org.kuali.rice.core.api.mo.common.Identifiable;
21 import org.kuali.rice.core.api.mo.common.Versioned;
22 import org.kuali.rice.core.api.mo.common.active.InactivatableFromTo;
23
24 import java.util.List;
25 import java.util.Map;
26
27 public interface RoleMemberContract extends Versioned, GloballyUnique, InactivatableFromTo, Identifiable {
28 /**
29 * This is the member id for the Role Member.
30 *
31 * <p>
32 * This is a id value that defines the Role Member. This value is either a Principal Id, Group Id, or Role Id
33 * depending on the type code
34 * </p>
35 *
36 * @return memberId
37 */
38 String getMemberId();
39
40 /**
41 * This is the type code for the Role Member.
42 *
43 * <p>
44 * This is a value that defines the type of Role Member. This value determines whether memberId is
45 * either a Principal Id, Group Id, or Role Id
46 * </p>
47 *
48 * @return typeCode
49 */
50 MemberType getType();
51
52 /**
53 * This is the id for the Role.
54 *
55 * <p>
56 * This is a id assigned to a Role. It defines the role this role member belongs to.
57 * </p>
58 *
59 * @return roleId
60 */
61 String getRoleId();
62
63 /**
64 * This returns specific attributes to be set on a Role Member in order to match permission and responsibilitys.
65 * These attributes match the attributes set to a KimType
66 *
67 * @return attributes
68 */
69 Map<String, String> getAttributes();
70
71 /**
72 * This returns a list of role responsibility actions assigned to a role member
73 *
74 * @return roleRspActions
75 */
76 List<? extends RoleResponsibilityActionContract> getRoleRspActions();
77
78 String getMemberName();
79
80 String getMemberNamespaceCode();
81 }