Package org.sakaiproject.sitemanage.api
Interface SectionField
-
public interface SectionFieldA SectionField models an input string used to look up a Section. Some typical SectionFields might include "Department", "Course", and "Section Number". From the strings in these SectionFields, one should be able to generate an EID for a Section.- Author:
- jholtzman@berkeley.edu
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetLabelKey()Gets the key to use in looking up the locale-specific label for this SectionField.intgetMaxSize()Gets the maximum number of characters allowed in this SectionField.StringgetValue()Gets the current value for this SectionField.voidsetValue(String value)Sets the value for this SectionField.
-
-
-
Method Detail
-
getLabelKey
String getLabelKey()
Gets the key to use in looking up the locale-specific label for this SectionField.- Returns:
-
getMaxSize
int getMaxSize()
Gets the maximum number of characters allowed in this SectionField.- Returns:
-
getValue
String getValue()
Gets the current value for this SectionField.- Returns:
-
setValue
void setValue(String value)
Sets the value for this SectionField.- Parameters:
value-
-
-