View Javadoc

1   /*
2    * Copyright 2007-2008 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.dao;
17  
18  import java.util.Collection;
19  import java.util.List;
20  import java.util.Map;
21  
22  import org.kuali.rice.kim.bo.group.dto.GroupMembershipInfo;
23  import org.kuali.rice.kim.bo.impl.RoleImpl;
24  import org.kuali.rice.kim.bo.role.dto.RoleMemberCompleteInfo;
25  import org.kuali.rice.kim.bo.role.dto.RoleMembershipInfo;
26  import org.kuali.rice.kim.bo.role.impl.KimDelegationImpl;
27  import org.kuali.rice.kim.bo.role.impl.KimDelegationMemberImpl;
28  import org.kuali.rice.kim.bo.role.impl.RoleMemberImpl;
29  import org.kuali.rice.kim.bo.types.dto.AttributeSet;
30  
31  /**
32   * This is a description of what this class does - jonathan don't forget to fill this in. 
33   * 
34   * @author Kuali Rice Team (rice.collab@kuali.org)
35   *
36   */
37  public interface KimRoleDao {
38  
39  	/**
40  	 * Returns a list of all the active RoleMemberImpl objects for the given principal and set of role IDs.
41  	 * 
42  	 * If the roleIds parameter is null, all RoleMemberImpls for the principal are returned.
43  	 */
44  	List<RoleMemberImpl> getRolePrincipalsForPrincipalIdAndRoleIds( Collection<String> roleIds, String principalId, AttributeSet qualification );
45  	
46  	List<GroupMembershipInfo> getGroupPrincipalsForPrincipalIdAndGroupIds( Collection<String> groupIds, String principalId );
47  	
48  	List<RoleMemberImpl> getRoleGroupsForGroupIdsAndRoleIds( Collection<String> roleIds, Collection<String> groupIds, AttributeSet qualification );
49  	
50  	Map<String,KimDelegationImpl> getDelegationImplMapFromRoleIds(Collection<String> roleIds);
51  	
52  	List<KimDelegationImpl> getDelegationImplsForRoleIds(Collection<String> roleIds);
53  	
54  	List<KimDelegationMemberImpl> getDelegationPrincipalsForPrincipalIdAndDelegationIds( Collection<String> delegationIds, String principalId );
55  
56  	List<KimDelegationMemberImpl> getDelegationGroupsForGroupIdsAndDelegationIds( Collection<String> delegationIds, List<String> groupIds );
57  	
58  	List<RoleMemberImpl> getRoleMembersForRoleIds( Collection<String> roleIds, String memberTypeCode, AttributeSet qualification );
59  	
60  	List<RoleMemberImpl> getRoleMembershipsForRoleIdsAsMembers(Collection<String> roleIds, AttributeSet qualification );
61  
62  	List<RoleMemberImpl> getRoleMembershipsForMemberId(String memberType, String memberId, AttributeSet qualification);
63  	
64  	List<RoleMemberImpl> getRoleMembersForRoleIdsWithFilters( Collection<String> roleIds, String principalId, List<String> groupIds, AttributeSet qualification );
65  	
66  	Map<String,List<KimDelegationMemberImpl>> getDelegationMembersForDelegationIds( List<String> delegationIds );
67  	
68      List<RoleImpl> getRoles(Map<String,String> fieldValues);
69  
70  	List<GroupMembershipInfo> getGroupMembers(Collection<String> groupIds);
71  	
72  	List<RoleMembershipInfo> getRoleMembers(Map<String,String> fieldValues);
73  
74  	List<RoleMemberCompleteInfo> getRoleMembersCompleteInfo(Map<String,String> fieldValues);
75  
76  }