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/SectionField.java $
03: * $Id: SectionField.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: /**
23: * A SectionField models an input string used to look up a Section. Some typical
24: * SectionFields might include "Department", "Course", and "Section Number".
25: * From the strings in these SectionFields, one should be able to generate an EID
26: * for a Section.
27: *
28: * @author <a href="mailto:jholtzman@berkeley.edu">jholtzman@berkeley.edu</a>
29: *
30: */
31: public interface SectionField {
32: /**
33: * Gets the key to use in looking up the locale-specific label for this SectionField.
34: * @return
35: */
36: public String getLabelKey();
37:
38: /**
39: * Gets the maximum number of characters allowed in this SectionField.
40: * @return
41: */
42: public int getMaxSize();
43:
44: /**
45: * Gets the current value for this SectionField.
46: * @return
47: */
48: public String getValue();
49:
50: /**
51: * Sets the value for this SectionField.
52: * @param value
53: */
54: public void setValue(String value);
55: }
|