01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/site-manage/tags/sakai_2-4-1/site-manage-api/api/src/java/org/sakaiproject/sitemanage/api/SectionFieldManager.java $
03: * $Id: SectionFieldManager.java 22875 2007-03-19 02:31:42Z daisyf@stanford.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2007 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.sitemanage.api;
21:
22: import java.util.List;
23:
24: /**
25: * The site management applications allow installations to configure a variable
26: * number of "fields" to use when looking up a Section from the
27: * CourseManagementService. The SectionFieldManager provides method for
28: * finding the number and type of fields to use in the UI, and for finding Section EIDs
29: * from a number of Fields.
30: *
31: * @author <a href="mailto:jholtzman@berkeley.edu">jholtzman@berkeley.edu</a>
32: *
33: */
34: public interface SectionFieldManager {
35:
36: /**
37: * Generates a Section EID from a List of fields. This EID may be used to look up
38: * Sections from the CourseManagementService. This may be implemented with
39: * simple text formatting, or an intermediary lookup may be needed to convert
40: * the human-understandable field values to a recognized EID.
41: *
42: * @param fields
43: * @return
44: */
45: public String getSectionEid(String academicSessionEid,
46: List<SectionField> fields);
47:
48: /**
49: * Gets the List of SectionFields to use in the UI.
50: *
51: * @return
52: */
53: public List<SectionField> getRequiredFields();
54: }
|