| org.sakaiproject.section.api.SectionAwareness
All known Subclasses: org.sakaiproject.component.section.SectionAwarenessHibernateImpl, org.sakaiproject.component.section.sakai.SectionAwarenessImpl,
| SectionAwareness | | public interface SectionAwareness (Code) | |
Provides section awareness to tools needing read-only access to section
information, such as section membership.
author:
Ray Davis
author:
Josh Holtzman |
| Method Summary | |
| public List | findSiteMembersInRole(String siteContext, Role role, String pattern)
Finds site members in the given context and
org.sakaiproject.section.api.facade.Role Role with a matching name or display id. | | public String | getCategoryName(String categoryId, Locale locale)
Gets the localized name of a given category. | | public CourseSection | getSection(String sectionUuid)
Gets a
org.sakaiproject.section.api.coursemanagement.CourseSection CourseSection by its uuid. | | public List | getSectionCategories(String siteContext)
Gets the list of section categories. | | public List | getSectionMembers(String sectionId)
Gets the full membership of the given section. | | public List | getSectionMembersInRole(String sectionUuid, Role role)
Gets the members of a given section that play a given role in the section. | | public List | getSections(String siteContext)
Gets the sections associated with this site context. | | public List | getSectionsInCategory(String siteContext, String categoryId)
Lists the sections in this context that are a member of the given category. | | public List | getSiteMembersInRole(String siteContext, Role role)
Gets the site membership for a given context. | | public List | getUnassignedMembersInRole(String siteContext, Role role)
Gets all users who are members of a site but are members of zero sections
within the site. | | public boolean | isSectionMemberInRole(String sectionId, String personId, Role role)
Checks whether a user plays a particular
org.sakaiproject.section.api.facade.Role Role in a section. | | public boolean | isSiteMemberInRole(String siteContext, String userUid, Role role)
Checks whether a user plays a particular
org.sakaiproject.section.api.facade.Role Role in a given site context. |
| INSTRUCTOR_MARKER | | final public static String INSTRUCTOR_MARKER(Code) | | The permission "marker" indicating that a role is the instructor role
|
| STUDENT_MARKER | | final public static String STUDENT_MARKER(Code) | | The permission "marker" indicating that a role is the student role
|
| TA_MARKER | | final public static String TA_MARKER(Code) | | The permission "marker" indicating that a role is the ta role
|
| findSiteMembersInRole | | public List findSiteMembersInRole(String siteContext, Role role, String pattern)(Code) | | Finds site members in the given context and
org.sakaiproject.section.api.facade.Role Role with a matching name or display id. Pattern matching is TBD, but will
probably match in any of the following cases:
- Display Name = pattern*
- Sort Name = pattern*
- Display Id (installation defined, either Email or enterprise id) = pattern*
Parameters:
siteContext - The site context
Parameters:
role - The role the user must play in this context
Parameters:
pattern - The pattern the user's name or id must match A java.util.List List oforg.sakaiproject.section.api.coursemanagement.ParticipationRecordParticipationRecords representing the users in the given site, playingthe given role, that match the string pattern. |
| getCategoryName | | public String getCategoryName(String categoryId, Locale locale)(Code) | | Gets the localized name of a given category.
Parameters:
categoryId - A string identifying the category
Parameters:
locale - The locale of the client An internationalized string to display for this category. |
| getSectionCategories | | public List getSectionCategories(String siteContext)(Code) | | Gets the list of section categories. In sakai 2.1, there will be only a
single set of categories. They will not be configurable on a per-course
or per-context bases. In future versions, the list of categories will
be configurable at the site level.
Parameters:
siteContext - The site context A List of unique Strings that identify the available sectioncategories. These should be internationalized for display usingSectionAwareness.getCategoryName(StringLocale) getCategoryName. |
| getUnassignedMembersInRole | | public List getUnassignedMembersInRole(String siteContext, Role role)(Code) | | Gets all users who are members of a site but are members of zero sections
within the site.
Parameters:
siteContext - The site context
Parameters:
role - The role that the user must play in the given site A List of ParticipationRecords |
| isSectionMemberInRole | | public boolean isSectionMemberInRole(String sectionId, String personId, Role role)(Code) | | Checks whether a user plays a particular
org.sakaiproject.section.api.facade.Role Role in a section.
Parameters:
sectionId -
Parameters:
personId -
Parameters:
role - Whether the user plays a particular role in a section. |
| isSiteMemberInRole | | public boolean isSiteMemberInRole(String siteContext, String userUid, Role role)(Code) | | Checks whether a user plays a particular
org.sakaiproject.section.api.facade.Role Role in a given site context.
Parameters:
siteContext - The site context
Parameters:
userUid - The user's unique id
Parameters:
role - The role we're checking Whether this user plays this role in this context. |
|
|