org.sakaiproject.sitemanage.api

Interface SectionFieldProvider

public interface SectionFieldProvider

The site management applications allow installations to configure a variable number of "fields" to use when looking up a Section from the CourseManagementService. The SectionFieldProvider provides method for finding the number and type of fields to use in the UI, and for finding Section EIDs from a number of Fields.

Author:

jholtzman@berkeley.edu

Method Summary

Modifier and Type	Method and Description
List<SectionField>	getRequiredFields() Gets the List of SectionFields to use in the UI.
String	getSectionEid(String academicSessionEid, List<SectionField> fields) Generates a Section EID from a List of fields.
String	getSectionTitle(String academicSessionEid, List<SectionField> fields) Generates a Section title from a list of fields.

Method Detail

getSectionEid

String getSectionEid(String academicSessionEid,
                     List<SectionField> fields)

Generates a Section EID from a List of fields. This EID may be used to look up Sections from the CourseManagementService. This may be implemented with simple text formatting, or an intermediary lookup may be needed to convert the human-understandable field values to a recognized EID.

Parameters:

fields -

Returns:

getSectionTitle

String getSectionTitle(String academicSessionEid,
                       List<SectionField> fields)

Generates a Section title from a list of fields. This title will be used ONLY if the section cannot be find from CourseManagementService otherwise, the title given by CourseManagementService will be used for the section

Parameters:

academicSessionEid -

fields -

Returns:

getRequiredFields

List<SectionField> getRequiredFields()

Gets the List of SectionFields to use in the UI.

Returns: