1 /**
2 * Copyright 2005-2013 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.Identifiable;
20 import org.kuali.rice.kim.api.common.delegate.DelegateTypeContract;
21
22 import java.util.List;
23 import java.util.Map;
24 /**
25 * This is a contract for RoleMembership. Role members can be Principals, Groups, or other Roles.
26 * Delegates can also be associated with a Role.
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 *
30 */
31
32 public interface RoleMembershipContract extends Identifiable {
33
34 String getRoleId();
35
36 Map<String, String> getQualifier();
37
38 List<? extends DelegateTypeContract> getDelegates();
39
40 String getMemberId();
41
42 MemberType getType();
43
44 /**
45 * @return String Identifier of the role from which the group or principal was derived.
46 */
47 String getEmbeddedRoleId();
48
49 /**
50 * @return String value used to sort the role members into a meaningful order
51 */
52 String getRoleSortingCode();
53 }