01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/msgcntr/tags/sakai_2-4-1/messageforums-api/src/java/org/sakaiproject/api/app/messageforums/MembershipManager.java $
03: * $Id: MembershipManager.java 9447 2006-05-15 14:31:39Z cwen@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.api.app.messageforums;
21:
22: import java.util.List;
23: import java.util.Map;
24:
25: public interface MembershipManager {
26:
27: /**
28: * Get filtered members for course all/user/role/group<br>
29: * Return hash map for direct access to members via id
30: * (used in UI when for selected list items)<br>
31: * Filter roles/groups which do not have members
32: * @param filterFerpa
33: * @return map of members
34: */
35: public Map getFilteredCourseMembers(boolean filterFerpa);
36:
37: /**
38: * Get members for course all/user/role/group<br>
39: * Return hash map for direct access to members via id
40: * (used in UI when for selected list items)<br>
41: * @param filterFerpa
42: * @param includeRoles
43: * @param includeAllParticipantsMember
44: * @return map of members
45: */
46: public Map getAllCourseMembers(boolean filterFerpa,
47: boolean includeRoles, boolean includeAllParticipantsMember);
48:
49: /**
50: * get all users for course w/o filtering of FERPA enabled members
51: * @return list of MembershipItems
52: */
53: public List getAllCourseUsers();
54:
55: /**
56: * returns a list for UI
57: * @param memberMap
58: * @return list of members
59: */
60: public List convertMemberMapToList(Map memberMap);
61:
62: }
|